javax.tools.diagnostics.runtime.java
Interface JavaHeap


public interface JavaHeap

Represents a single heap of managed objects. The heap can be viewed as an unordered collection of JavaObjects or as a region of storage within the Java Virtual Machine instance. The heap commonly contains JavaObject instances that are reachable by navigating chains of JavaReference These references can be obtained from the JavaRuntime.getHeapRoots() method. A heap can contain instances which cannot be reached by the use of JavaReference


Method Summary
 boolean equals(java.lang.Object obj)
           
 java.lang.String getName()
          Get a brief textual description of this heap.
 java.util.List<JavaObject> getObjects()
          Get the set of objects which are stored in this heap.
 java.util.List<ImageSection> getSections()
          Get the set of memory regions that represent the memory layout of the heap.
 int hashCode()
           
 

Method Detail

getSections

java.util.List<ImageSection> getSections()
Get the set of memory regions that represent the memory layout of the heap. The actual make up of this list is implementation specific. The returned list follows the standard semantics for javax.tools.diagnostics collections. The returned value is never null but can be an empty list.

Returns:
a list of ImageSection instances
See Also:
ImageSection

getName

java.lang.String getName()
Get a brief textual description of this heap. The value returned is implementation specific. The returned value is never null.

Returns:
a brief textual description of this heap

getObjects

java.util.List<JavaObject> getObjects()
Get the set of objects which are stored in this heap.

Returns:
a list of JavaObject objects which are stored in this heap The returned list follows the standard semantics for javax.tools.diagnostics collections. The returned value is never null but can be an empty list.
See Also:
JavaObject

equals

boolean equals(java.lang.Object obj)
Overrides:
equals in class java.lang.Object
Parameters:
obj -
Returns:
true if the given object refers to the same Java Heap in the image

hashCode

int hashCode()
Overrides:
hashCode in class java.lang.Object


Copyright © 2010. All Rights Reserved.