This class is not part of the public API.

Class: com.sun.management.GcInfo

Garbage collection information. It contains the following information for one garbage collection as well as GC-specific attributes:
  • Start time
  • End time
  • Duration
  • Memory usage before the collection starts
  • Memory usage after the collection ends

GcInfo is a CompositeData The GC-specific attributes can be obtained via the CompositeData interface. This is a historical relic, and other classes should not copy this pattern. Use javax.management.openmbean.CompositeDataView instead.

MXBean Mapping

GcInfo is mapped to a CompositeData with attributes as specified in the from method.
Authors:
@author Mandy Chung
Since:
@since 1.5

Inheritance

Superclass tree: Implements:

Methods

  • GcInfotop

    private GcInfo(CompositeData cd)
    Related Links:
    Google Code Search
    Stack Overflow

  • GcInfotop

    private GcInfo(GcInfoBuilder builder, long index, long startTime, long endTime, MemoryUsage[] muBeforeGc, MemoryUsage[] muAfterGc, Object[] extAttributes)
    Related Links:
    Google Code Search
    Stack Overflow

  • containsKeytop

    public boolean containsKey(String key)
    Returns true if and only if this CompositeData instance contains an item whose name is key. If key is a null or empty String, this method simply returns false.
    Parameters:
    @param key the key to be tested.
    Return:
    @return true if this CompositeData contains the key.
    Specified by:
    containsKey from CompositeData
    Related Links:
    Google Code Search
    Stack Overflow

  • containsValuetop

    public boolean containsValue(Object value)
    Returns true if and only if this CompositeData instance contains an item whose value is value.
    Parameters:
    @param value the value to be tested.
    Return:
    @return true if this CompositeData contains the value.
    Specified by:
    containsValue from CompositeData
    Related Links:
    Google Code Search
    Stack Overflow

  • equalstop

    public boolean equals(Object obj)
    Compares the specified obj parameter with this CompositeData instance for equality.

    Returns true if and only if all of the following statements are true:

    • obj is non null,
    • obj also implements the CompositeData interface,
    • their composite types are equal
    • their contents, i.e. (name, value) pairs are equal. If a value contained in the content is an array, the value comparison is done as if by calling the deepEquals method for arrays of object reference types or the appropriate overloading of Arrays.equals(e1,e2) for arrays of primitive types

    This ensures that this equals method works properly for obj parameters which are different implementations of the CompositeData interface, with the restrictions mentioned in the equals method of the java.util.Collection interface.

    Parameters:
    @param obj the object to be compared for equality with this CompositeData instance.
    Return:
    @return true if the specified object is equal to this CompositeData instance.
    Specified by:
    equals from CompositeData
    Override hierarchy:
    equals from Object
    Related Links:
    Google Code Search
    Stack Overflow

  • fromtop

    public static GcInfo from(CompositeData cd)
    Returns a GcInfo object represented by the given CompositeData. The given CompositeData must contain all the following attributes:

    Attribute NameType
    indexjava.lang.Long
    startTimejava.lang.Long
    endTimejava.lang.Long
    memoryUsageBeforeGcjavax.management.openmbean.TabularData
    memoryUsageAfterGcjavax.management.openmbean.TabularData
    Return:
    @return a GcInfo object represented by cd if cd is not null; null otherwise.
    Exceptions:
    @throws IllegalArgumentException if cd does not represent a GcInfo object with the attributes described above.
    Related Links:
    Google Code Search
    Stack Overflow

  • gettop

    public Object get(String key)
    Returns the value of the item whose name is key.
    Parameters:
    @param key the name of the item.
    Return:
    @return the value associated with this key.
    Specified by:
    get from CompositeData
    Related Links:
    Google Code Search
    Stack Overflow

  • getAlltop

    public Object[] getAll(String[] keys)
    Returns an array of the values of the items whose names are specified by keys, in the same order as keys.
    Parameters:
    @param keys the names of the items.
    Return:
    @return the values corresponding to the keys.
    Specified by:
    getAll from CompositeData
    Related Links:
    Google Code Search
    Stack Overflow

  • getCompositeTypetop

    public CompositeType getCompositeType()
    Returns the composite type of this composite data instance.
    Return:
    @return the type of this CompositeData.
    Specified by:
    getCompositeType from CompositeData
    Related Links:
    Google Code Search
    Stack Overflow

  • getDurationtop

    public long getDuration()
    Returns the elapsed time of this GC in milliseconds.
    Return:
    @return the elapsed time of this GC in milliseconds.
    Related Links:
    Google Code Search
    Stack Overflow

  • getEndTimetop

    public long getEndTime()
    Returns the end time of this GC in milliseconds since the Java virtual machine was started.
    Return:
    @return the end time of this GC.
    Related Links:
    Google Code Search
    Stack Overflow

  • getIdtop

    public long getId()
    Returns the identifier of this garbage collection which is the number of collections that this collector has done.
    Return:
    @return the identifier of this garbage collection which is the number of collections that this collector has done.
    Related Links:
    Google Code Search
    Stack Overflow

  • getMemoryUsageAfterGctop

    public Map<String, MemoryUsage> getMemoryUsageAfterGc()
    Returns the memory usage of all memory pools at the end of this GC. This method returns a Map of the name of a memory pool to the memory usage of the corresponding memory pool when GC finishes.
    Return:
    @return a Map of memory pool names to the memory usage of a memory pool when GC finishes.
    Related Links:
    Google Code Search
    Stack Overflow

  • getMemoryUsageBeforeGctop

    public Map<String, MemoryUsage> getMemoryUsageBeforeGc()
    Returns the memory usage of all memory pools at the beginning of this GC. This method returns a Map of the name of a memory pool to the memory usage of the corresponding memory pool before GC starts.
    Return:
    @return a Map of memory pool names to the memory usage of a memory pool before GC starts.
    Related Links:
    Google Code Search
    Stack Overflow

  • getStartTimetop

    public long getStartTime()
    Returns the start time of this GC in milliseconds since the Java virtual machine was started.
    Return:
    @return the start time of this GC.
    Related Links:
    Google Code Search
    Stack Overflow

  • hashCodetop

    public int hashCode()
    Returns the hash code value for this CompositeData instance.

    The hash code of a CompositeData instance is the sum of the hash codes of all elements of information used in equals comparisons (ie: its composite type and all the item values).

    This ensures that t1.equals(t2) implies that t1.hashCode()==t2.hashCode() for any two CompositeData instances t1 and t2, as required by the general contract of the method Object.hashCode().

    Each item value's hash code is added to the returned hash code. If an item value is an array, its hash code is obtained as if by calling the deepHashCode method for arrays of object reference types or the appropriate overloading of Arrays.hashCode(e) for arrays of primitive types.

    Return:
    @return the hash code value for this CompositeData instance
    Specified by:
    hashCode from CompositeData
    Override hierarchy:
    hashCode from Object
    Related Links:
    Google Code Search
    Stack Overflow

  • toCompositeDatatop

    public CompositeData toCompositeData(CompositeType ct)

    Return the CompositeData representation of this GcInfo, including any GC-specific attributes. The returned value will have at least all the attributes described in the from method, plus optionally other attributes.

    Parameters:
    @param ct the CompositeType that the caller expects. This parameter is ignored and can be null.
    Return:
    @return the CompositeData representation.
    Specified by:
    toCompositeData from CompositeDataView
    Related Links:
    Google Code Search
    Stack Overflow

  • toStringtop

    public String toString()
    Returns a string representation of this CompositeData instance.

    The string representation consists of the name of the implementing class, the string representation of the composite type of this instance, and the string representation of the contents (ie list the itemName=itemValue mappings).

    Return:
    @return a string representation of this CompositeData instance
    Specified by:
    toString from CompositeData
    Override hierarchy:
    toString from Object
    Related Links:
    Google Code Search
    Stack Overflow

  • valuestop

    public Collection values()
    Returns an unmodifiable Collection view of the item values contained in this CompositeData instance. The returned collection's iterator will return the values in the ascending lexicographic order of the corresponding item names.
    Return:
    @return the values.
    Specified by:
    values from CompositeData
    Related Links:
    Google Code Search
    Stack Overflow

Fields

  • builder

    final private GcInfoBuilder builder

  • cdata

    final private CompositeData cdata

  • endTime

    final private long endTime

  • extAttributes

    final private Object[] extAttributes

  • index

    final private long index

  • startTime

    final private long startTime

  • usageAfterGc

    final private Map<String, MemoryUsage> usageAfterGc

  • usageBeforeGc

    final private Map<String, MemoryUsage> usageBeforeGc