org.jlf.vitals.virtualMachine
Class MemoryInUseVitalSign

java.lang.Object
  |
  +--org.jlf.vitals.VitalSign
        |
        +--org.jlf.vitals.virtualMachine.MemoryInUseVitalSign

public class MemoryInUseVitalSign
extends VitalSign

AvailableMemoryVitalSign is a class that periodically measures the available memory in the virtual machine.

See Also:
VitalSign

Field Summary
 
Fields inherited from class org.jlf.vitals.VitalSign
childInstances, childVitalKey, isActiveFlag, isParentVital, properties, statistics, timeLastChildInstancesCollected, timeLastVitalMeasurementRegistered, vitalKey
 
Constructor Summary
MemoryInUseVitalSign(java.lang.String vitalKey, VitalSignProperties properties)
          Creates the vital sign.
 
Method Summary
 AbstractVitalMeasurement basicGetMaximumMeasurement()
          Returns the maximum theoritical value of the vital sign.
protected  AbstractVitalMeasurement getCurrentMeasurement()
          Takes a measurement of the vital sign at the current moment and returns it to the caller.
 
Methods inherited from class org.jlf.vitals.VitalSign
basicCreateChildInstance, collectChildInstanceMeasurements, collectMeasurement, findOrCreateChildInstance, getChildInstance, getChildInstances, getChildVitalKey, getInstance, getInstance, getMaximumMeasurement, getProperties, getStatistics, getVitalKey, hasChildInstances, isActive, isParentVital, isVitalApplicable, putChildInstance, refreshChildInstances, registerMeasurement, setChildVitalKey, setIsActiveFlag, setIsParentVital, shouldChildInstancesBeCollected, shouldMeasurementBeCollected, vitalKeyForChildVitalKey
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

MemoryInUseVitalSign

public MemoryInUseVitalSign(java.lang.String vitalKey,
                            VitalSignProperties properties)
Creates the vital sign. This method must pass-through to the super-class so the vital sign can be auto-loaded.

Method Detail

getCurrentMeasurement

protected AbstractVitalMeasurement getCurrentMeasurement()
Takes a measurement of the vital sign at the current moment and returns it to the caller. This method should be implemented by subclasses that are automatically called by the vitals manager on a periodic basis. The default implementation in this superclass is to return null, leaving the implementation to a subclass.

Overrides:
getCurrentMeasurement in class VitalSign
Returns:
the current measurement for this vital sign or null if no implementation

basicGetMaximumMeasurement

public AbstractVitalMeasurement basicGetMaximumMeasurement()
Returns the maximum theoritical value of the vital sign.

Overrides:
basicGetMaximumMeasurement in class VitalSign
Returns:
the current measurement for this vital sign or null if no implementation