com.ibm.dtfj.java

Interface JavaRuntimeMemoryCategory


  1. public interface JavaRuntimeMemoryCategory

Represents a category of native memory allocated by the Java runtime.

A category is a high-level grouping of memory allocations such as "Threads", "Classes" or "Java Heap".

Some Java runtime implementations use categories to track native memory use in the JRE.

Categories can have child categories and form a hierarchy.

The getShallow* methods return the allocation data for just this category. The getDeep* methods return the allocation data for this category and all its child categories.

Since:
1.5

Method Summary

Modifier and Type Method and Description
  1. java.util.Iterator
getChildren()
Gets iterator of child categories.
  1. long
getDeepAllocations()
Gets number of allocations recorded against this category, and all children of this category.
  1. long
getDeepBytes()
Gets number of bytes recorded against this category, and all children of this category.
  1. java.util.Iterator
getMemorySections(boolean includeFreed)
Gets iterator of memory sections allocated against this category.
  1. java.lang.String
getName()
Gets the name of this category.
  1. long
getShallowAllocations()
Gets number of allocations recorded against this category.
  1. long
getShallowBytes()
Gets number of bytes allocated under this category.

Method Detail

getName

  1. java.lang.String getName()
  2. throws CorruptDataException
Gets the name of this category. E.g. "Classes".
Returns:
Name string.
Throws:

getShallowAllocations

  1. long getShallowAllocations()
  2. throws CorruptDataException
Gets number of allocations recorded against this category.
Returns:
Allocation count.
Throws:

getShallowBytes

  1. long getShallowBytes()
  2. throws CorruptDataException
Gets number of bytes allocated under this category.
Returns:
Number of bytes.
Throws:

getDeepAllocations

  1. long getDeepAllocations()
  2. throws CorruptDataException
Gets number of allocations recorded against this category, and all children of this category.
Returns:
Allocation count.
Throws:

getDeepBytes

  1. long getDeepBytes()
  2. throws CorruptDataException
Gets number of bytes recorded against this category, and all children of this category.
Returns:
Number of bytes.
Throws:

getChildren

  1. java.util.Iterator getChildren( )
  2. throws CorruptDataException
Gets iterator of child categories.
Returns:
Iterator of JavaRuntimeMemoryCategory objects that are immediate children of this category.
Throws:

getMemorySections

  1. java.util.Iterator getMemorySections( boolean includeFreed)
  2. throws CorruptDataException
  3. DataUnavailable
Gets iterator of memory sections allocated against this category.
Parameters:
includeFreed - If true, iterator will iterate over blocks of memory that have been freed, but haven't been re-used yet.
Returns:
Iterator of memory sections
Throws:
See Also: