This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.


javax.management.monitor
interface GaugeMonitorMBean

All Superinterfaces:
MonitorMBean
All Known Implementing Classes:
GaugeMonitor

public interface GaugeMonitorMBean
extends MonitorMBean

Exposes the remote management interface of the gauge monitor MBean.


Method Summary
 Number

          Gets the derived gauge.
 Number

          Gets the derived gauge for the specified MBean.
 long

          Gets the derived gauge timestamp.
 long

          Gets the derived gauge timestamp for the specified MBean.
 boolean

          Gets the difference mode flag value.
 Number

          Gets the high threshold value.
 Number

          Gets the low threshold value.
 boolean

          Gets the high notification's on/off switch value.
 boolean

          Gets the low notification's on/off switch value.
 void
setDifferenceMode(boolean value)

          Sets the difference mode flag value.
 void
setNotifyHigh(boolean value)

          Sets the high notification's on/off switch value.
 void
setNotifyLow(boolean value)

          Sets the low notification's on/off switch value.
 void
setThresholds(Number highValue, Number lowValue)

          Sets the high and the low threshold values.
 
Methods inherited from class javax.management.monitor.MonitorMBean
addObservedObject, containsObservedObject, getGranularityPeriod, getObservedAttribute, getObservedObject, getObservedObjects, isActive, removeObservedObject, setGranularityPeriod, setObservedAttribute, setObservedObject, start, stop
 

Method Detail

getDerivedGauge

public Number getDerivedGauge()
Gets the derived gauge.

Returns:
The derived gauge.

getDerivedGauge

public Number getDerivedGauge(ObjectName object)
Gets the derived gauge for the specified MBean.

Parameters:
object - the MBean for which the derived gauge is to be returned
Returns:
The derived gauge for the specified MBean if this MBean is in the set of observed MBeans, or null otherwise.

getDerivedGaugeTimeStamp

public long getDerivedGaugeTimeStamp()
Gets the derived gauge timestamp.

Returns:
The derived gauge timestamp.

getDerivedGaugeTimeStamp

public long getDerivedGaugeTimeStamp(ObjectName object)
Gets the derived gauge timestamp for the specified MBean.

Parameters:
object - the MBean for which the derived gauge timestamp is to be returned
Returns:
The derived gauge timestamp for the specified MBean if this MBean is in the set of observed MBeans, or null otherwise.

getDifferenceMode

public boolean getDifferenceMode()
Gets the difference mode flag value.

Returns:
true if the difference mode is used, false otherwise.

getHighThreshold

public Number getHighThreshold()
Gets the high threshold value.

Returns:
The high threshold value.

getLowThreshold

public Number getLowThreshold()
Gets the low threshold value.

Returns:
The low threshold value.

getNotifyHigh

public boolean getNotifyHigh()
Gets the high notification's on/off switch value.

Returns:
true if the gauge monitor notifies when exceeding the high threshold, false otherwise.

getNotifyLow

public boolean getNotifyLow()
Gets the low notification's on/off switch value.

Returns:
true if the gauge monitor notifies when exceeding the low threshold, false otherwise.

setDifferenceMode

public void setDifferenceMode(boolean value)
Sets the difference mode flag value.

Parameters:
value - The difference mode flag value.

setNotifyHigh

public void setNotifyHigh(boolean value)
Sets the high notification's on/off switch value.

Parameters:
value - The high notification's on/off switch value.

setNotifyLow

public void setNotifyLow(boolean value)
Sets the low notification's on/off switch value.

Parameters:
value - The low notification's on/off switch value.

setThresholds

public void setThresholds(Number highValue,
                          Number lowValue)
                   throws IllegalArgumentException
Sets the high and the low threshold values.

Parameters:
highValue - The high threshold value.
lowValue - The low threshold value.
Throws:
IllegalArgumentException - The specified high/low threshold is null or the low threshold is greater than the high threshold or the high threshold and the low threshold are not of the same type.


This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.
This page displays the Jadeite version of the documention, which is derived from the offical documentation that contains this copyright notice:
Copyright 2008 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
The official Sun™ documentation can be found here at http://java.sun.com/javase/6/docs/api/.