| Prev Class | Next Class | Frames | No Frames |
| Summary: Nested | Field | Method | Constr | Detail: Nested | Field | Method | Constr |
java.lang.Objectjavax.management.StandardMBeangnu.java.lang.management.BeanImplgnu.java.lang.management.MemoryPoolMXBeanImplManagementFactory.getMemoryPoolMXBeans().
Constructor Summary | |
| |
Method Summary | |
MemoryUsage |
|
long |
|
long |
|
String[] |
|
String |
|
MemoryUsage |
|
MemoryType |
|
MemoryUsage |
|
long |
|
long |
|
boolean |
|
boolean |
|
boolean |
|
boolean |
|
boolean |
|
void |
|
void |
|
void |
|
Methods inherited from class gnu.java.lang.management.BeanImpl | |
cacheMBeanInfo, checkControlPermissions, checkMonitorPermissions, getAttribute, getCachedMBeanInfo, getDescription, getDescription, getMBeanInfo, getParameterName, getParameterName | |
Methods inherited from class javax.management.StandardMBean | |
cacheMBeanInfo, getAttribute, getAttributes, getCachedMBeanInfo, getClassName, getConstructors, getDescription, getDescription, getDescription, getDescription, getDescription, getDescription, getDescription, getImpact, getImplementation, getImplementationClass, getMBeanInfo, getMBeanInterface, getParameterName, getParameterName, invoke, setAttribute, setAttributes, setImplementation | |
Methods inherited from class java.lang.Object | |
clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait | |
public MemoryPoolMXBeanImpl(String name) throws NotCompliantMBeanException
Constructs a newMemoryPoolMXBeanImpl.
- Parameters:
name- the name of the pool this bean represents.
- Throws:
NotCompliantMBeanException- if this class doesn't implement the interface or a method appears in the interface that doesn't comply with the naming conventions.
public MemoryUsage getCollectionUsage()
Returns memory usage statistics after a best-effort attempt has been made to remove unused objects from the pool. This method is designed for use by the pools of garbage collectors, in order to monitor the amount of memory used after collections. It will returnnullif such functionality is unsupported by the memory pool represented by this bean.
- Specified by:
- getCollectionUsage in interface MemoryPoolMXBean
- Returns:
- the memory usage of the memory pool after the most recent garbage collection cycle, or
nullif this operation is not supported.
public long getCollectionUsageThreshold()
Returns the collection usage threshold level in bytes. This value is initially zero.
- Specified by:
- getCollectionUsageThreshold in interface MemoryPoolMXBean
- Returns:
- the collection usage threshold in bytes.
- Throws:
UnsupportedOperationException- if the collection usage threshold is not supported.
public long getCollectionUsageThresholdCount()
Returns the number of times the usage level has matched or exceeded the collection usage threshold.
- Specified by:
- getCollectionUsageThresholdCount in interface MemoryPoolMXBean
- Returns:
- the number of times the usage level has matched or exceeded the collection usage threshold.
- Throws:
UnsupportedOperationException- if the collection usage threshold is not supported.
public String[] getMemoryManagerNames()
Returns the names of the memory managers associated with this pool. Each pool has at least one memory manager.
- Specified by:
- getMemoryManagerNames in interface MemoryPoolMXBean
- Returns:
- an array containing the name of each memory manager responsible for this pool.
public String getName()
Returns the name of the memory pool.
- Specified by:
- getName in interface MemoryPoolMXBean
- Returns:
- the memory pool name.
public MemoryUsage getPeakUsage()
Returns memory usage statistics for the peak memory usage of the pool. The peak is the maximum memory usage occurring since the virtual machine was started or since the peak was reset byMemoryPoolMXBean.resetPeakUsage(). The return value may benullif this pool is no longer valid.
- Specified by:
- getPeakUsage in interface MemoryPoolMXBean
- Returns:
- the memory usage of the memory pool at its peak, or
nullif this pool is no longer valid.
public MemoryType getType()
Returns the type of memory used by this pool. This can be either heap or non-heap memory.
- Specified by:
- getType in interface MemoryPoolMXBean
- Returns:
- the type of this pool.
public MemoryUsage getUsage()
Returns memory usage statistics for the current memory usage of the pool. The return value may benullif this pool is no longer valid. Obtaining these values is expected to be a relatively quick operation; if this will instead be an expensive operation to perform, the documentation of the implementating bean should specify that this is the case. The values are intended to be an estimate for monitoring purposes.
- Specified by:
- getUsage in interface MemoryPoolMXBean
- Returns:
- the memory usage of the memory pool at present, or
nullif this pool is no longer valid.
public long getUsageThreshold()
Returns the usage threshold level in bytes. This value is initially defined by the virtual machine.
- Specified by:
- getUsageThreshold in interface MemoryPoolMXBean
- Returns:
- the usage threshold in bytes.
- Throws:
UnsupportedOperationException- if the usage threshold is not supported.
public long getUsageThresholdCount()
Returns the number of times the usage level has matched or exceeded the usage threshold.
- Specified by:
- getUsageThresholdCount in interface MemoryPoolMXBean
- Returns:
- the number of times the usage level has matched or exceeded the usage threshold.
- Throws:
UnsupportedOperationException- if the usage threshold is not supported.
public boolean isCollectionUsageThresholdExceeded()
Returns true if the collection usage level is equal to or greater than the collection usage threshold.
- Specified by:
- isCollectionUsageThresholdExceeded in interface MemoryPoolMXBean
- Returns:
- true if the collection usage threshold has been matched or exceeded.
- Throws:
UnsupportedOperationException- if the collection usage threshold is not supported.
public boolean isCollectionUsageThresholdSupported()
Returns true if this memory pool supports a collection usage level threshold.
- Specified by:
- isCollectionUsageThresholdSupported in interface MemoryPoolMXBean
- Returns:
- true if a collection usage level threshold is supported.
public boolean isUsageThresholdExceeded()
Returns true if the usage level is equal to or greater than the usage threshold.
- Specified by:
- isUsageThresholdExceeded in interface MemoryPoolMXBean
- Returns:
- true if the usage threshold has been matched or exceeded.
- Throws:
UnsupportedOperationException- if the usage threshold is not supported.
public boolean isUsageThresholdSupported()
Returns true if this memory pool supports a usage level threshold.
- Specified by:
- isUsageThresholdSupported in interface MemoryPoolMXBean
- Returns:
- true if a usage level threshold is supported.
public boolean isValid()
Returns true if this memory pool is still valid. A memory pool becomes invalid when it is removed by the virtual machine and no longer used.
- Specified by:
- isValid in interface MemoryPoolMXBean
- Returns:
- true if this memory pool is valid.
public void resetPeakUsage()
Resets the peak memory usage level to the current memory usage level.
- Specified by:
- resetPeakUsage in interface MemoryPoolMXBean
- Throws:
SecurityException- if a security manager exists and denies ManagementPermission("control").
public void setCollectionUsageThreshold(long threshold)
Sets the collection threshold usage level to the given value. A value of zero disables the collection threshold.
- Specified by:
- setCollectionUsageThreshold in interface MemoryPoolMXBean
- Parameters:
threshold- the new threshold level.
- Throws:
IllegalArgumentException- if the threshold hold level is negative.UnsupportedOperationException- if the collection usage threshold is not supported.SecurityException- if a security manager exists and denies ManagementPermission("control").
public void setUsageThreshold(long threshold)
Sets the threshold usage level to the given value. A value of zero disables the threshold.
- Specified by:
- setUsageThreshold in interface MemoryPoolMXBean
- Parameters:
threshold- the new threshold level.
- Throws:
IllegalArgumentException- if the threshold hold level is negative.UnsupportedOperationException- if the usage threshold is not supported.SecurityException- if a security manager exists and denies ManagementPermission("control").