Module openj9.dtfj
Package com.ibm.j9ddr.vm29.j9.gc

Class GCHeapRegionIterator

java.lang.Object
com.ibm.j9ddr.vm29.j9.gc.GCBase
com.ibm.j9ddr.vm29.j9.gc.GCIterator
com.ibm.j9ddr.vm29.j9.gc.GCHeapRegionIterator
All Implemented Interfaces:
SlotIterator, Iterator
public class GCHeapRegionIterator extends GCIterator

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    GCHeapRegionIterator(com.ibm.j9ddr.vm29.pointer.generated.MM_HeapRegionManagerPointer manager, com.ibm.j9ddr.vm29.pointer.generated.MM_MemorySpacePointer space, boolean includeTableRegions, boolean includeAuxRegions)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    static GCHeapRegionIterator
    from()
     
    static GCHeapRegionIterator
    fromMMHeapRegionManager(com.ibm.j9ddr.vm29.pointer.generated.MM_HeapRegionManagerPointer manager, boolean includeTableRegions, boolean includeAuxRegions)
    Factory method to construct an appropriate segment iterator.
    static GCHeapRegionIterator
    fromMMHeapRegionManager(com.ibm.j9ddr.vm29.pointer.generated.MM_HeapRegionManagerPointer manager, com.ibm.j9ddr.vm29.pointer.generated.MM_MemorySpacePointer space)
    Factory method to construct an appropriate segment iterator.
    static GCHeapRegionIterator
    fromMMHeapRegionManager(com.ibm.j9ddr.vm29.pointer.generated.MM_HeapRegionManagerPointer manager, com.ibm.j9ddr.vm29.pointer.generated.MM_MemorySpacePointer space, boolean includeTableRegions, boolean includeAuxRegions)
    Factory method to construct an appropriate segment iterator.
    protected com.ibm.j9ddr.vm29.pointer.generated.MM_HeapRegionDescriptorPointer
    getNextAuxiliaryRegion(com.ibm.j9ddr.vm29.pointer.generated.MM_HeapRegionDescriptorPointer heapRegion)
     
    protected com.ibm.j9ddr.vm29.pointer.generated.MM_HeapRegionDescriptorPointer
    getNextTableRegion(com.ibm.j9ddr.vm29.pointer.generated.MM_HeapRegionDescriptorPointer heapRegion)
     
    boolean
    hasNext()
    Returns true if the iteration has more elements.
    GCHeapRegionDescriptor
    next()
    Returns the next element in the iteration.
    VoidPointer
    nextAddress()
     
    protected boolean
    shouldIncludeRegion(com.ibm.j9ddr.vm29.pointer.generated.MM_HeapRegionDescriptorPointer region)
    Determine if the specified region should be included or skipped.

    Methods declared in class com.ibm.j9ddr.vm29.j9.gc.GCBase

    getExtensions, getJavaVM

    Methods declared in class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods declared in interface java.util.Iterator

    forEachRemaining, remove

  • Constructor Details

    • GCHeapRegionIterator

      protected GCHeapRegionIterator(com.ibm.j9ddr.vm29.pointer.generated.MM_HeapRegionManagerPointer manager, com.ibm.j9ddr.vm29.pointer.generated.MM_MemorySpacePointer space, boolean includeTableRegions, boolean includeAuxRegions) throws CorruptDataException
      Throws:
      CorruptDataException

  • Method Details

    • fromMMHeapRegionManager

      public static GCHeapRegionIterator fromMMHeapRegionManager(com.ibm.j9ddr.vm29.pointer.generated.MM_HeapRegionManagerPointer manager, com.ibm.j9ddr.vm29.pointer.generated.MM_MemorySpacePointer space, boolean includeTableRegions, boolean includeAuxRegions) throws CorruptDataException
      Factory method to construct an appropriate segment iterator.
      Parameters:
      manager - the MM_HeapRegionManagerPointer to iterate
      space - only iterate regions which belong to the specified memory space
      includeTableRegions - include table regions in the iteration
      includeAuxRegions - include auxiliary regions in the iteration
      Returns:
      an instance of GCHeapRegionIterator
      Throws:
      CorruptDataException

    • from

      public static GCHeapRegionIterator from() throws CorruptDataException
      Throws:
      CorruptDataException

    • fromMMHeapRegionManager

      public static GCHeapRegionIterator fromMMHeapRegionManager(com.ibm.j9ddr.vm29.pointer.generated.MM_HeapRegionManagerPointer manager, com.ibm.j9ddr.vm29.pointer.generated.MM_MemorySpacePointer space) throws CorruptDataException
      Factory method to construct an appropriate segment iterator.
      Parameters:
      manager - the MM_HeapRegionManagerPointer to iterate
      space - only iterate regions which belong to the specified memory space
      Returns:
      an instance of GCHeapRegionIterator
      Throws:
      CorruptDataException

    • fromMMHeapRegionManager

      public static GCHeapRegionIterator fromMMHeapRegionManager(com.ibm.j9ddr.vm29.pointer.generated.MM_HeapRegionManagerPointer manager, boolean includeTableRegions, boolean includeAuxRegions) throws CorruptDataException
      Factory method to construct an appropriate segment iterator.
      Parameters:
      manager - the MM_HeapRegionManagerPointer to iterate
      includeTableRegions - include table regions in the iteration
      includeAuxRegions - include auxiliary regions in the iteration
      Returns:
      an instance of GCHeapRegionIterator
      Throws:
      CorruptDataException

    • shouldIncludeRegion

      protected boolean shouldIncludeRegion(com.ibm.j9ddr.vm29.pointer.generated.MM_HeapRegionDescriptorPointer region) throws CorruptDataException
      Determine if the specified region should be included or skipped.
      Returns:
      true if the region should be included, false otherwise
      Throws:
      CorruptDataException

    • getNextAuxiliaryRegion

      protected com.ibm.j9ddr.vm29.pointer.generated.MM_HeapRegionDescriptorPointer getNextAuxiliaryRegion(com.ibm.j9ddr.vm29.pointer.generated.MM_HeapRegionDescriptorPointer heapRegion) throws CorruptDataException
      Throws:
      CorruptDataException

    • getNextTableRegion

      protected com.ibm.j9ddr.vm29.pointer.generated.MM_HeapRegionDescriptorPointer getNextTableRegion(com.ibm.j9ddr.vm29.pointer.generated.MM_HeapRegionDescriptorPointer heapRegion) throws CorruptDataException
      Throws:
      CorruptDataException

    • hasNext

      public boolean hasNext()
      Description copied from interface: java.util.Iterator
      Returns true if the iteration has more elements. (In other words, returns true if Iterator.next() would return an element rather than throwing an exception.)
      Returns:
      true if the iteration has more elements

    • next

      public GCHeapRegionDescriptor next()
      Description copied from interface: java.util.Iterator
      Returns the next element in the iteration.
      Returns:
      the next element in the iteration

    • nextAddress

      public VoidPointer nextAddress()