Top Description Methods
javax.management.monitor

public Interface StringMonitorMBean

extends MonitorMBean
Known Direct Implementers
javax.management.monitor.StringMonitor
Imports
javax.management.ObjectName

Exposes the remote management interface of the string monitor MBean.
Since
1.5

Method Summary

Modifier and TypeMethod and Description
public String

Returns:

The derived gauge.
getDerivedGauge
()
Deprecated As of JMX 1.2, replaced by getDerivedGauge(ObjectName)

Gets the derived gauge.

public String

Returns:

The derived gauge for the specified MBean if this MBean is in the set of observed MBeans, or null otherwise.
getDerivedGauge
(ObjectName
the MBean for which the derived gauge is to be returned
object
)

Gets the derived gauge for the specified MBean.

public long

Returns:

The derived gauge timestamp.
getDerivedGaugeTimeStamp
()
Deprecated As of JMX 1.2, replaced by getDerivedGaugeTimeStamp(ObjectName)

Gets the derived gauge timestamp.

public long

Returns:

The derived gauge timestamp for the specified MBean if this MBean is in the set of observed MBeans, or null otherwise.
getDerivedGaugeTimeStamp
(ObjectName
the MBean for which the derived gauge timestamp is to be returned
object
)

Gets the derived gauge timestamp for the specified MBean.

public boolean

Returns:

true if the string monitor notifies when differing, false otherwise.
getNotifyDiffer
()

Gets the differing notification's on/off switch value.

public boolean

Returns:

true if the string monitor notifies when matching, false otherwise.
getNotifyMatch
()

Gets the matching notification's on/off switch value.

public String

Returns:

The string value.
getStringToCompare
()

Gets the string to compare with the observed attribute.

public void
setNotifyDiffer(boolean
The differing notification's on/off switch value.
value
)

Sets the differing notification's on/off switch value.

public void
setNotifyMatch(boolean
The matching notification's on/off switch value.
value
)

Sets the matching notification's on/off switch value.

public void
setStringToCompare(String
The string value.
value
)

Sets the string to compare with the observed attribute.

Inherited from javax.management.monitor.MonitorMBean:
addObservedObjectcontainsObservedObjectgetGranularityPeriodgetObservedAttributegetObservedObjectgetObservedObjectsisActiveremoveObservedObjectsetGranularityPeriodsetObservedAttributesetObservedObjectstartstop

Method Detail

getDerivedGaugeback to summary
public String getDerivedGauge()

Deprecated

As of JMX 1.2, replaced by getDerivedGauge(ObjectName)

Gets the derived gauge.

Returns:String

The derived gauge.

Annotations
@Deprecated
getDerivedGaugeback to summary
public String getDerivedGauge(ObjectName object)

Gets the derived gauge for the specified MBean.

Parameters
object:ObjectName

the MBean for which the derived gauge is to be returned

Returns:String

The derived gauge for the specified MBean if this MBean is in the set of observed MBeans, or null otherwise.

getDerivedGaugeTimeStampback to summary
public long getDerivedGaugeTimeStamp()

Deprecated

As of JMX 1.2, replaced by getDerivedGaugeTimeStamp(ObjectName)

Gets the derived gauge timestamp.

Returns:long

The derived gauge timestamp.

Annotations
@Deprecated
getDerivedGaugeTimeStampback to summary
public long getDerivedGaugeTimeStamp(ObjectName object)

Gets the derived gauge timestamp for the specified MBean.

Parameters
object:ObjectName

the MBean for which the derived gauge timestamp is to be returned

Returns:long

The derived gauge timestamp for the specified MBean if this MBean is in the set of observed MBeans, or null otherwise.

getNotifyDifferback to summary
public boolean getNotifyDiffer()

Gets the differing notification's on/off switch value.

Returns:boolean

true if the string monitor notifies when differing, false otherwise.

See Also
setNotifyDiffer
getNotifyMatchback to summary
public boolean getNotifyMatch()

Gets the matching notification's on/off switch value.

Returns:boolean

true if the string monitor notifies when matching, false otherwise.

See Also
setNotifyMatch
getStringToCompareback to summary
public String getStringToCompare()

Gets the string to compare with the observed attribute.

Returns:String

The string value.

See Also
setStringToCompare
setNotifyDifferback to summary
public void setNotifyDiffer(boolean value)

Sets the differing notification's on/off switch value.

Parameters
value:boolean

The differing notification's on/off switch value.

See Also
getNotifyDiffer
setNotifyMatchback to summary
public void setNotifyMatch(boolean value)

Sets the matching notification's on/off switch value.

Parameters
value:boolean

The matching notification's on/off switch value.

See Also
getNotifyMatch
setStringToCompareback to summary
public void setStringToCompare(String value) throws IllegalArgumentException

Sets the string to compare with the observed attribute.

Parameters
value:String

The string value.

Exceptions
IllegalArgumentException:
The specified string to compare is null.
See Also
getStringToCompare