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.
Overview  Package   Class 
 PREV CLASS   NEXT CLASS FRAMES   NO FRAMES 
SUMMARY: NESTED | FIELD | CONSTR | METHOD  DETAIL: FIELD | CONSTR | METHOD 

javax.management.monitor
interface CounterMonitorMBean

All Superinterfaces:
MonitorMBean
All Known Implementing Classes:
CounterMonitor
public interface CounterMonitorMBean
extends MonitorMBean

Exposes the remote management interface of the counter monitor MBean.

Method Summary
 Number
getDerivedGauge()

          Gets the derived gauge.
 Number
getDerivedGauge(ObjectName object)

          Gets the derived gauge for the specified MBean.
 long
getDerivedGaugeTimeStamp()

          Gets the derived gauge timestamp.
 long
getDerivedGaugeTimeStamp(ObjectName object)

          Gets the derived gauge timestamp for the specified MBean.
 boolean
getDifferenceMode()

          Gets the difference mode flag value.
 Number
getInitThreshold()

          Gets the initial threshold value common to all observed objects.
 Number
getModulus()

          Gets the modulus value.
 boolean
getNotify()

          Gets the notification's on/off switch value.
 Number
getOffset()

          Gets the offset value.
 Number
getThreshold()

          Gets the threshold value.
 Number
getThreshold(ObjectName object)

          Gets the threshold value for the specified MBean.
 void
setDifferenceMode(boolean value)

          Sets the difference mode flag value.
 void
setInitThreshold(Number value)

          Sets the initial threshold value common to all observed MBeans.
 void
setModulus(Number value)

          Sets the modulus value.
 void
setNotify(boolean value)

          Sets the notification's on/off switch value.
 void
setOffset(Number value)

          Sets the offset value.
 void
setThreshold(Number value)

          Sets the threshold value.
 
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.

getInitThreshold

public Number getInitThreshold()
Gets the initial threshold value common to all observed objects.

Returns:
The initial threshold value.

getModulus

public Number getModulus()
Gets the modulus value.

Returns:
The modulus value.

getNotify

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

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

getOffset

public Number getOffset()
Gets the offset value.

Returns:
The offset value.

getThreshold

public Number getThreshold()
Gets the threshold value.

Returns:
The threshold value.

getThreshold

public Number getThreshold(ObjectName object)
Gets the threshold value for the specified MBean.

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

setDifferenceMode

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

Parameters:
value - The difference mode flag value.

setInitThreshold

public void setInitThreshold(Number value)
                      throws IllegalArgumentException
Sets the initial threshold value common to all observed MBeans.

Parameters:
value - The initial threshold value.
Throws:
IllegalArgumentException - The specified threshold is null or the threshold value is less than zero.

setModulus

public void setModulus(Number value)
                throws IllegalArgumentException
Sets the modulus value.

Parameters:
value - The modulus value.
Throws:
IllegalArgumentException - The specified modulus is null or the modulus value is less than zero.

setNotify

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

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

setOffset

public void setOffset(Number value)
               throws IllegalArgumentException
Sets the offset value.

Parameters:
value - The offset value.
Throws:
IllegalArgumentException - The specified offset is null or the offset value is less than zero.

setThreshold

public void setThreshold(Number value)
                  throws IllegalArgumentException
Sets the threshold value.

Parameters:
value - The threshold value.
Throws:
IllegalArgumentException - The specified threshold is null or the threshold value is less than zero.
Overview  Package   Class 
 PREV CLASS   NEXT CLASS FRAMES   NO FRAMES 
SUMMARY: NESTED | FIELD | CONSTR | METHOD  DETAIL: FIELD | CONSTR | METHOD 
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/.