Class GcInfo
- All Implemented Interfaces:
CompositeData,CompositeDataView
- 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 Summary
Modifier 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.booleanCompares the specified obj parameter with thisCompositeDatainstance for equality.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 the hash code value for thisCompositeDatainstance.Return theCompositeDatarepresentation of thisGcInfo, including any GC-specific attributes.toString()Returns a string representation of thisCompositeDatainstance.Collection<?> values()Returns an unmodifiable Collection view of the item values contained in thisCompositeDatainstance.
-
Method Details
-
getId
public 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.
-
getStartTime
public 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.
-
getEndTime
public 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.
-
getDuration
public long getDuration()Returns the elapsed time of this GC in milliseconds.- Returns:
- the elapsed time of this GC in milliseconds.
-
getMemoryUsageBeforeGc
Returns 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.
-
getMemoryUsageAfterGc
Returns 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.
-
from
Returns 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- ifcddoes not represent aGcInfoobject with the attributes described above.
-
containsKey
Description 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 interfaceCompositeData- Parameters:
key- the key to be tested.- Returns:
- true if this
CompositeDatacontains the key.
-
containsValue
Description copied from interface:CompositeDataReturnstrueif and only if thisCompositeDatainstance contains an item whose value isvalue.- Specified by:
containsValuein interfaceCompositeData- Parameters:
value- the value to be tested.- Returns:
- true if this
CompositeDatacontains the value.
-
equals
Description copied from interface:CompositeDataCompares the specified obj parameter with thisCompositeDatainstance for equality.Returns
trueif and only if all of the following statements are true:- obj is non null,
- obj also implements the
CompositeDatainterface, - 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
deepEqualsmethod for arrays of object reference types or the appropriate overloading ofArrays.equals(e1,e2)for arrays of primitive types
This ensures that this
equalsmethod works properly for obj parameters which are different implementations of theCompositeDatainterface, with the restrictions mentioned in theequalsmethod of thejava.util.Collectioninterface.- Specified by:
equalsin interfaceCompositeData- Overrides:
equalsin classObject- Parameters:
obj- the object to be compared for equality with thisCompositeDatainstance.- Returns:
trueif the specified object is equal to thisCompositeDatainstance.- See Also:
-
get
Description copied from interface:CompositeDataReturns the value of the item whose name iskey.- Specified by:
getin interfaceCompositeData- Parameters:
key- the name of the item.- Returns:
- the value associated with this key.
-
getAll
Description 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 interfaceCompositeData- Parameters:
keys- the names of the items.- Returns:
- the values corresponding to the keys.
-
getCompositeType
Description copied from interface:CompositeDataReturns the composite type of this composite data instance.- Specified by:
getCompositeTypein interfaceCompositeData- Returns:
- the type of this CompositeData.
-
hashCode
public int hashCode()Description copied from interface:CompositeDataReturns the hash code value for thisCompositeDatainstance.The hash code of a
CompositeDatainstance is the sum of the hash codes of all elements of information used inequalscomparisons (ie: its composite type and all the item values).This ensures that
t1.equals(t2)implies thatt1.hashCode()==t2.hashCode()for any twoCompositeDatainstancest1andt2, as required by the general contract of the methodObject.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
deepHashCodemethod for arrays of object reference types or the appropriate overloading ofArrays.hashCode(e)for arrays of primitive types.- Specified by:
hashCodein interfaceCompositeData- Overrides:
hashCodein classObject- Returns:
- the hash code value for this
CompositeDatainstance - See Also:
-
toString
Description copied from interface:CompositeDataReturns a string representation of thisCompositeDatainstance.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).
- Specified by:
toStringin interfaceCompositeData- Overrides:
toStringin classObject- Returns:
- a string representation of this
CompositeDatainstance
-
values
Description 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 interfaceCompositeData- Returns:
- the values.
-
toCompositeData
Return 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 interfaceCompositeDataView- Parameters:
ct- theCompositeTypethat the caller expects. This parameter is ignored and can be null.- Returns:
- the
CompositeDatarepresentation.
-