java.lang.Object
com.sun.management.GcInfo
- All Implemented Interfaces:
- CompositeData,- CompositeDataView
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 CompositeDataView instead.
 
MXBean Mapping
GcInfo is mapped to a CompositeData
 with attributes as specified in the from method.- Since:
- 1.5
- 
Method SummaryModifier and TypeMethodDescriptionbooleancontainsKey(String key) Returnstrueif and only if thisCompositeDatainstance contains an item whose name iskey.booleancontainsValue(Object value) Returnstrueif and only if thisCompositeDatainstance contains an item whose value isvalue.booleanIndicates whether some other object is "equal to" this one.static GcInfofrom(CompositeData cd) Returns aGcInfoobject represented by the givenCompositeData.Returns the value of the item whose name iskey.Object[]Returns an array of the values of the items whose names are specified bykeys, in the same order askeys.Returns the composite type of this composite data instance.longReturns the elapsed time of this GC in milliseconds.longReturns the end time of this GC in milliseconds since the Java virtual machine was started.longgetId()Returns the identifier of this garbage collection which is the number of collections that this collector has done.Returns the memory usage of all memory pools at the end of this GC.Returns the memory usage of all memory pools at the beginning of this GC.longReturns the start time of this GC in milliseconds since the Java virtual machine was started.inthashCode()Returns a hash code value for the object.Return theCompositeDatarepresentation of thisGcInfo, including any GC-specific attributes.toString()Returns a string representation of the object.Collection<?> values()Returns an unmodifiable Collection view of the item values contained in thisCompositeDatainstance.
- 
Method Details- 
getIdpublic long getId()Returns the identifier of this garbage collection which is the number of collections that this collector has done.- Returns:
- the identifier of this garbage collection which is the number of collections that this collector has done.
 
- 
getStartTimepublic long getStartTime()Returns the start time of this GC in milliseconds since the Java virtual machine was started.- Returns:
- the start time of this GC.
 
- 
getEndTimepublic long getEndTime()Returns the end time of this GC in milliseconds since the Java virtual machine was started.- Returns:
- the end time of this GC.
 
- 
getDurationpublic long getDuration()Returns the elapsed time of this GC in milliseconds.- Returns:
- the elapsed time of this GC in milliseconds.
 
- 
getMemoryUsageBeforeGcReturns the memory usage of all memory pools at the beginning of this GC. This method returns aMapof the name of a memory pool to the memory usage of the corresponding memory pool before GC starts.- Returns:
- a Mapof memory pool names to the memory usage of a memory pool before GC starts.
 
- 
getMemoryUsageAfterGcReturns the memory usage of all memory pools at the end of this GC. This method returns aMapof the name of a memory pool to the memory usage of the corresponding memory pool when GC finishes.- Returns:
- a Mapof memory pool names to the memory usage of a memory pool when GC finishes.
 
- 
fromReturns aGcInfoobject represented by the givenCompositeData. The givenCompositeDatamust contain all the following attributes:Attribute Name Type index java.lang.LongstartTime java.lang.LongendTime java.lang.LongmemoryUsageBeforeGc javax.management.openmbean.TabularDatamemoryUsageAfterGc javax.management.openmbean.TabularData- Returns:
- a GcInfoobject represented bycdifcdis notnull;nullotherwise.
- Throws:
- IllegalArgumentException- if- cddoes not represent a- GcInfoobject with the attributes described above.
 
- 
containsKeyDescription copied from interface:CompositeDataReturnstrueif and only if thisCompositeDatainstance contains an item whose name iskey. Ifkeyis a null or empty String, this method simply returns false.- Specified by:
- containsKeyin interface- CompositeData
- Parameters:
- key- the key to be tested.
- Returns:
- true if this CompositeDatacontains the key.
 
- 
containsValueDescription copied from interface:CompositeDataReturnstrueif and only if thisCompositeDatainstance contains an item whose value isvalue.- Specified by:
- containsValuein interface- CompositeData
- Parameters:
- value- the value to be tested.
- Returns:
- true if this CompositeDatacontains the value.
 
- 
equalsDescription copied from class:ObjectIndicates whether some other object is "equal to" this one.The equalsmethod implements an equivalence relation on non-null object references:- It is reflexive: for any non-null reference value
     x,x.equals(x)should returntrue.
- It is symmetric: for any non-null reference values
     xandy,x.equals(y)should returntrueif and only ify.equals(x)returnstrue.
- It is transitive: for any non-null reference values
     x,y, andz, ifx.equals(y)returnstrueandy.equals(z)returnstrue, thenx.equals(z)should returntrue.
- It is consistent: for any non-null reference values
     xandy, multiple invocations ofx.equals(y)consistently returntrueor consistently returnfalse, provided no information used inequalscomparisons on the objects is modified.
- For any non-null reference value x,x.equals(null)should returnfalse.
 An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. - Specified by:
- equalsin interface- CompositeData
- Overrides:
- equalsin class- Object
- Parameters:
- obj- the reference object with which to compare.
- Returns:
- trueif this object is the same as the obj argument;- falseotherwise.
- See Also:
 
- It is reflexive: for any non-null reference value
     
- 
getDescription copied from interface:CompositeDataReturns the value of the item whose name iskey.- Specified by:
- getin interface- CompositeData
- Parameters:
- key- the name of the item.
- Returns:
- the value associated with this key.
 
- 
getAllDescription copied from interface:CompositeDataReturns an array of the values of the items whose names are specified bykeys, in the same order askeys.- Specified by:
- getAllin interface- CompositeData
- Parameters:
- keys- the names of the items.
- Returns:
- the values corresponding to the keys.
 
- 
getCompositeTypeDescription copied from interface:CompositeDataReturns the composite type of this composite data instance.- Specified by:
- getCompositeTypein interface- CompositeData
- Returns:
- the type of this CompositeData.
 
- 
hashCodepublic int hashCode()Description copied from class:ObjectReturns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided byHashMap.The general contract of hashCodeis:- Whenever it is invoked on the same object more than once during
     an execution of a Java application, the hashCodemethod must consistently return the same integer, provided no information used inequalscomparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
- If two objects are equal according to the equalsmethod, then calling thehashCodemethod on each of the two objects must produce the same integer result.
- It is not required that if two objects are unequal
     according to the equalsmethod, then calling thehashCodemethod on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
 - Specified by:
- hashCodein interface- CompositeData
- Overrides:
- hashCodein class- Object
- Returns:
- a hash code value for this object.
- See Also:
 
- Whenever it is invoked on the same object more than once during
     an execution of a Java application, the 
- 
toStringDescription copied from class:ObjectReturns a string representation of the object.- Specified by:
- toStringin interface- CompositeData
- Overrides:
- toStringin class- Object
- Returns:
- a string representation of the object.
 
- 
valuesDescription copied from interface:CompositeDataReturns an unmodifiable Collection view of the item values contained in thisCompositeDatainstance. The returned collection's iterator will return the values in the ascending lexicographic order of the corresponding item names.- Specified by:
- valuesin interface- CompositeData
- Returns:
- the values.
 
- 
toCompositeDataReturn theCompositeDatarepresentation of thisGcInfo, including any GC-specific attributes. The returned value will have at least all the attributes described in thefrommethod, plus optionally other attributes.- Specified by:
- toCompositeDatain interface- CompositeDataView
- Parameters:
- ct- the- CompositeTypethat the caller expects. This parameter is ignored and can be null.
- Returns:
- the CompositeDatarepresentation.
 
 
-