com.unboundid.ldap.sdk.unboundidds.monitors
Class NumericGaugeMonitorEntry

java.lang.Object
  extended by com.unboundid.ldap.sdk.unboundidds.monitors.MonitorEntry
      extended by com.unboundid.ldap.sdk.unboundidds.monitors.GaugeMonitorEntry
          extended by com.unboundid.ldap.sdk.unboundidds.monitors.NumericGaugeMonitorEntry
All Implemented Interfaces:
java.io.Serializable

@NotMutable
@ThreadSafety(level=COMPLETELY_THREADSAFE)
public final class NumericGaugeMonitorEntry
extends GaugeMonitorEntry

NOTE: This class is part of the Commercial Edition of the UnboundID LDAP SDK for Java. It is not available for use in applications that include only the Standard Edition of the LDAP SDK, and is not supported for use in conjunction with non-UnboundID products.
This class defines a numeric gauge monitor entry, which obtains its information from a numeric value in a monitor entry.

See Also:
Serialized Form

Constructor Summary
NumericGaugeMonitorEntry(Entry entry)
          Creates a new numeric gauge monitor entry from the provided entry.
 
Method Summary
 java.lang.Double getCurrentValue()
          Retrieves the current value for the gauge, if available.
 java.lang.Double getMaximumValue()
          Retrieves the maximum value observed for the gauge, if available.
 java.lang.Double getMinimumValue()
          Retrieves the minimum value observed for the gauge, if available.
 java.util.Map<java.lang.String,MonitorAttribute> getMonitorAttributes()
          Retrieves the set of parsed monitor attributes for this monitor entry, mapped from a unique identifier (in all lowercase characters) to the corresponding monitor attribute.
 java.lang.String getMonitorDescription()
          Retrieves a human-readable description name for this monitor entry.
 java.lang.String getMonitorDisplayName()
          Retrieves a human-readable display name for this monitor entry.
 java.util.List<java.lang.Double> getObservedValues()
          Retrieves the set of observed values for the gauge, if available.
 java.lang.Double getPreviousValue()
          Retrieves the previous value for the gauge, if available.
 
Methods inherited from class com.unboundid.ldap.sdk.unboundidds.monitors.GaugeMonitorEntry
getCurrentSeverity, getCurrentSeverityDurationMillis, getCurrentSeverityDurationString, getCurrentSeverityStartTime, getErrorMessages, getGaugeName, getInitTime, getLastCriticalStateDurationMillis, getLastCriticalStateDurationString, getLastCriticalStateEndTime, getLastCriticalStateStartTime, getLastMajorStateDurationMillis, getLastMajorStateDurationString, getLastMajorStateEndTime, getLastMajorStateStartTime, getLastMinorStateDurationMillis, getLastMinorStateDurationString, getLastMinorStateEndTime, getLastMinorStateStartTime, getLastNormalStateDurationMillis, getLastNormalStateDurationString, getLastNormalStateEndTime, getLastNormalStateStartTime, getLastWarningStateDurationMillis, getLastWarningStateDurationString, getLastWarningStateEndTime, getLastWarningStateStartTime, getPreviousSeverity, getResource, getResourceType, getSamplesThisInterval, getSummary, getTotalCriticalStateDurationMillis, getTotalCriticalStateDurationString, getTotalMajorStateDurationMillis, getTotalMajorStateDurationString, getTotalMinorStateDurationMillis, getTotalMinorStateDurationString, getTotalNormalStateDurationMillis, getTotalNormalStateDurationString, getTotalWarningStateDurationMillis, getTotalWarningStateDurationString, getUpdateTime
 
Methods inherited from class com.unboundid.ldap.sdk.unboundidds.monitors.MonitorEntry
addMonitorAttribute, addMonitorAttribute, addMonitorAttribute, addMonitorAttribute, addMonitorAttribute, addMonitorAttribute, addMonitorAttribute, decode, getBoolean, getDate, getDN, getDouble, getEntry, getInteger, getLong, getMonitorClass, getMonitorName, getString, getStrings, toString, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

NumericGaugeMonitorEntry

public NumericGaugeMonitorEntry(Entry entry)
Creates a new numeric gauge monitor entry from the provided entry.

Parameters:
entry - The entry to be parsed as a numeric gauge monitor entry. It must not be null.
Method Detail

getCurrentValue

public java.lang.Double getCurrentValue()
Retrieves the current value for the gauge, if available.

Returns:
The current value for the gauge, or null if it was not included in the monitor entry.

getPreviousValue

public java.lang.Double getPreviousValue()
Retrieves the previous value for the gauge, if available.

Returns:
The previous value for the gauge, or null if it was not included in the monitor entry.

getMinimumValue

public java.lang.Double getMinimumValue()
Retrieves the minimum value observed for the gauge, if available.

Returns:
The minimum value observed for the gauge, or null if it was not included in the monitor entry.

getMaximumValue

public java.lang.Double getMaximumValue()
Retrieves the maximum value observed for the gauge, if available.

Returns:
The maximum value observed for the gauge, or null if it was not included in the monitor entry.

getObservedValues

public java.util.List<java.lang.Double> getObservedValues()
Retrieves the set of observed values for the gauge, if available.

Returns:
The set of observed values for the gauge, or null if it was not included in the monitor entry.

getMonitorDisplayName

public java.lang.String getMonitorDisplayName()
Retrieves a human-readable display name for this monitor entry.

Overrides:
getMonitorDisplayName in class GaugeMonitorEntry
Returns:
A human-readable display name for this monitor entry.

getMonitorDescription

public java.lang.String getMonitorDescription()
Retrieves a human-readable description name for this monitor entry.

Overrides:
getMonitorDescription in class GaugeMonitorEntry
Returns:
A human-readable description name for this monitor entry.

getMonitorAttributes

public java.util.Map<java.lang.String,MonitorAttribute> getMonitorAttributes()
Retrieves the set of parsed monitor attributes for this monitor entry, mapped from a unique identifier (in all lowercase characters) to the corresponding monitor attribute.

Overrides:
getMonitorAttributes in class GaugeMonitorEntry
Returns:
The set of parsed monitor attributes for this monitor entry.