FileDocCategorySizeDatePackage
AttributeChangeNotificationFilter.javaAPI DocJava SE 5 API3937Fri Aug 26 14:57:32 BST 2005javax.management

AttributeChangeNotificationFilter

public class AttributeChangeNotificationFilter extends Object implements NotificationFilter, Serializable
This class implements of the {@link javax.management.NotificationFilter NotificationFilter} interface for the {@link javax.management.AttributeChangeNotification attribute change notification}. The filtering is performed on the name of the observed attribute.

It manages a list of enabled attribute names. A method allows users to enable/disable as many attribute names as required.

since
1.5

Fields Summary
private static final long
serialVersionUID
private Vector
enabledAttributes
Constructors Summary
Methods Summary
public synchronized voiddisableAllAttributes()
Disables all the attribute names.

        enabledAttributes.removeAllElements();
    
public synchronized voiddisableAttribute(java.lang.String name)
Disables all the attribute change notifications the attribute name of which equals the specified attribute name to be sent to the listener.
If the specified name is not in the list of enabled attribute names, this method has no effect.

param
name The attribute name.

        enabledAttributes.removeElement(name);
    
public synchronized voidenableAttribute(java.lang.String name)
Enables all the attribute change notifications the attribute name of which equals the specified name to be sent to the listener.
If the specified name is already in the list of enabled attribute names, this method has no effect.

param
name The attribute name.
exception
java.lang.IllegalArgumentException The attribute name parameter is null.

        
        if (name == null) {
            throw new java.lang.IllegalArgumentException("The name cannot be null.");
        }
        if (!enabledAttributes.contains(name)) {
            enabledAttributes.addElement(name);
        }
    
public synchronized java.util.VectorgetEnabledAttributes()
Gets all the enabled attribute names for this filter.

return
The list containing all the enabled attribute names.

        return enabledAttributes;
    
public synchronized booleanisNotificationEnabled(javax.management.Notification notification)
Invoked before sending the specified notification to the listener.
This filter compares the attribute name of the specified attribute change notification with each enabled attribute name. If the attribute name equals one of the enabled attribute names, the notification must be sent to the listener and this method returns true.

param
notification The attribute change notification to be sent.
return
true if the notification has to be sent to the listener, false otherwise.



                                                                                       
         
        
        String type = notification.getType();
        
        if ((type == null) || 
            (type.equals(AttributeChangeNotification.ATTRIBUTE_CHANGE) == false) ||
            (!(notification instanceof AttributeChangeNotification))) {
            return false;
        }
        
        String attributeName =
          ((AttributeChangeNotification)notification).getAttributeName();
        return enabledAttributes.contains(attributeName);