blackboard.platform.monitor.memory
Interface MemoryMonitorService

All Superinterfaces:
MonitorService<MemoryMonitor>

public interface MemoryMonitorService
extends MonitorService<MemoryMonitor>

The MemoryMonitorService class offers methods to obtain MemoryMonitor monitors, as well as information about the various memory pools defined by the Java Virtual Machine.

Since:
Bb 9.1

Method Summary
 java.util.List<java.lang.String> getMemoryPoolNames()
          Returns the names of all memory pools in the system.
 java.util.List<MemoryPoolInfo> getMemoryPools()
          Returns information about all memory pools in the system.
 MemoryMonitor getMonitor(java.lang.String poolName)
          Returns the MemoryMonitor for the specified memory pool.
 

Method Detail

getMemoryPoolNames

java.util.List<java.lang.String> getMemoryPoolNames()
Returns the names of all memory pools in the system.

Returns:
A list of memory pool names

getMemoryPools

java.util.List<MemoryPoolInfo> getMemoryPools()
Returns information about all memory pools in the system.

Returns:
A list of memory pool information

getMonitor

MemoryMonitor getMonitor(java.lang.String poolName)
                         throws java.lang.IllegalArgumentException
Returns the MemoryMonitor for the specified memory pool. In order to get a list of valid memory pools, use getMemoryPoolNames().

Parameters:
poolName - The memory pool for which to retrieve a monitor
Returns:
A memory pool monitor
Throws:
java.lang.IllegalArgumentException - If the specified pool name did not correspond to a valid memory pool.


Copyright © 2012 Blackboard, Inc. All Rights Reserved.