Module openj9.dtfj
Package com.ibm.dtfj.java

Interface JavaHeap

  • All Known Implementing Classes:
    DTFJJavaHeap, JavaHeap
    public interface JavaHeap

    Represents a heap of managed objects.

    There may be multiple heaps within a JVM, for instance a generational heap and a class heap. Additionally, heaps may consist of non-contiguous memory regions. For instance, an object heap may be divided into a hot and cold section.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      boolean equals​(Object obj)
      Compares the argument to the receiver, and answers true if they represent the same object using a class specific comparison.
      String getName()
      Get a brief textual description of this heap.
      Iterator getObjects()
      Get the set of objects which are stored in this heap.
      Iterator getSections()
      Get the set of contiguous memory regions which form this heap.
      int hashCode()
      Answers an integer hash code for the receiver.

    • Method Detail

      • getSections

        Iterator getSections()
        Get the set of contiguous memory regions which form this heap.
        Returns:
        an iterator over the collection of contiguous memory regions which form this heap
        See Also:
        ImageSection, CorruptData

      • getName

        String getName()
        Get a brief textual description of this heap.
        Returns:
        a brief textual description of this heap

      • getObjects

        Iterator getObjects()
        Get the set of objects which are stored in this heap.
        Returns:
        an iterator over the collection of objects which are stored in this heap
        See Also:
        JavaObject, CorruptData

      • equals

        boolean equals​(Object obj)
        Description copied from class: java.lang.Object
        Compares the argument to the receiver, and answers true if they represent the same object using a class specific comparison. The implementation in Object answers true only if the argument is the exact same object as the receiver (==).
        Overrides:
        equals in class Object
        Parameters:
        obj -
        Returns:
        True if the given object refers to the same Java Heap in the image
        See Also:
        Object.hashCode()

      • hashCode

        int hashCode()
        Description copied from class: java.lang.Object
        Answers an integer hash code for the receiver. Any two objects which answer true when passed to .equals must answer the same value for this method.
        Overrides:
        hashCode in class Object
        Returns:
        the receiver's hash.
        See Also:
        Object.equals(java.lang.Object)