Package Summary Overview Summary

### class:StringMonitor [NONE]
All Implemented Interfaces: `MBeanRegistration, MonitorMBean, StringMonitorMBean, NotificationBroadcaster, NotificationEmitter` public class StringMonitor extends Monitor implements StringMonitorMBean Defines a monitor MBean designed to observe the values of a string attribute. A string monitor sends notifications as follows: if the attribute value matches the string to compare value, a `match notification` is sent. The notify match flag must be set to `true`. Subsequent matchings of the string to compare values do not cause further notifications unless the attribute value differs from the string to compare value. if the attribute value differs from the string to compare value, a `differ notification` is sent. The notify differ flag must be set to `true`. Subsequent differences from the string to compare value do not cause further notifications unless the attribute value matches the string to compare value. Since: 1.5

### constructor:StringMonitor() [NONE]
### StringMonitor public StringMonitor() Default constructor.

### method:start() [NONE]
### start public void start() Starts the string monitor. Specified by: `start` in interface `MonitorMBean` Specified by: `start` in class `Monitor`

### method:stop() [NONE]
### stop public void stop() Stops the string monitor. Specified by: `stop` in interface `MonitorMBean` Specified by: `stop` in class `Monitor`

### method:getDerivedGauge(javax.management.ObjectName) [NONE]
### getDerivedGauge public String getDerivedGauge (ObjectName object) Gets the derived gauge of the specified object, if this object is contained in the set of observed MBeans, or `null` otherwise. Specified by: `getDerivedGauge` in interface `StringMonitorMBean` Parameters: `object` - the name of the MBean whose derived gauge is required. Returns: The derived gauge of the specified object.

### method:getDerivedGaugeTimeStamp(javax.management.ObjectName) [NONE]
### getDerivedGaugeTimeStamp public long getDerivedGaugeTimeStamp (ObjectName object) Gets the derived gauge timestamp of the specified object, if this object is contained in the set of observed MBeans, or `0` otherwise. Specified by: `getDerivedGaugeTimeStamp` in interface `StringMonitorMBean` Parameters: `object` - the name of the object whose derived gauge timestamp is to be returned. Returns: The derived gauge timestamp of the specified object.

### method:getDerivedGauge() [NONE]
### getDerivedGauge @Deprecated public String getDerivedGauge() Deprecated. As of JMX 1.2, replaced by `getDerivedGauge(ObjectName)` Returns the derived gauge of the first object in the set of observed MBeans. Specified by: `getDerivedGauge` in interface `StringMonitorMBean` Returns: The derived gauge.

### method:getDerivedGaugeTimeStamp() [NONE]
### getDerivedGaugeTimeStamp @Deprecated public long getDerivedGaugeTimeStamp() Deprecated. As of JMX 1.2, replaced by `getDerivedGaugeTimeStamp(ObjectName)` Gets the derived gauge timestamp of the first object in the set of observed MBeans. Specified by: `getDerivedGaugeTimeStamp` in interface `StringMonitorMBean` Returns: The derived gauge timestamp.

### method:getStringToCompare() [NONE]
### getStringToCompare public String getStringToCompare() Gets the string to compare with the observed attribute common to all observed MBeans. Specified by: `getStringToCompare` in interface `StringMonitorMBean` Returns: The string value. See Also: `setStringToCompare(String)`

### method:setStringToCompare(java.lang.String) [NONE]
### setStringToCompare public void setStringToCompare (String value) throws IllegalArgumentException Sets the string to compare with the observed attribute common to all observed MBeans. Specified by: `setStringToCompare` in interface `StringMonitorMBean` Parameters: `value` - The string value. Throws: `IllegalArgumentException` - The specified string to compare is null. See Also: `getStringToCompare()`

### method:getNotifyMatch() [NONE]
### getNotifyMatch public boolean getNotifyMatch() Gets the matching notification's on/off switch value common to all observed MBeans. Specified by: `getNotifyMatch` in interface `StringMonitorMBean` Returns: `true` if the string monitor notifies when matching the string to compare, `false` otherwise. See Also: `setNotifyMatch(boolean)`

### method:setNotifyMatch(boolean) [NONE]
### setNotifyMatch public void setNotifyMatch (boolean value) Sets the matching notification's on/off switch value common to all observed MBeans. Specified by: `setNotifyMatch` in interface `StringMonitorMBean` Parameters: `value` - The matching notification's on/off switch value. See Also: `getNotifyMatch()`

### method:getNotifyDiffer() [NONE]
### getNotifyDiffer public boolean getNotifyDiffer() Gets the differing notification's on/off switch value common to all observed MBeans. Specified by: `getNotifyDiffer` in interface `StringMonitorMBean` Returns: `true` if the string monitor notifies when differing from the string to compare, `false` otherwise. See Also: `setNotifyDiffer(boolean)`

### method:setNotifyDiffer(boolean) [NONE]
### setNotifyDiffer public void setNotifyDiffer (boolean value) Sets the differing notification's on/off switch value common to all observed MBeans. Specified by: `setNotifyDiffer` in interface `StringMonitorMBean` Parameters: `value` - The differing notification's on/off switch value. See Also: `getNotifyDiffer()`

### method:getNotificationInfo() [NONE]
### getNotificationInfo public MBeanNotificationInfo[] getNotificationInfo() Returns a `NotificationInfo` object containing the name of the Java class of the notification and the notification types sent by the string monitor. Specified by: `getNotificationInfo` in interface `NotificationBroadcaster` Returns: the array of possible notifications.