AttributeChangeNotificationFilter (Java 2 Platform Ent. Ed. v1.4) - Java Platform, Enterprise Edition v1.4 API Specifications

Overview

Package

Class

Tree

Deprecated

Index

Help

Java^TM 2 Platform
Ent. Ed. v1.4

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

javax.management
Class AttributeChangeNotificationFilter

java.lang.Object
  javax.management.AttributeChangeNotificationFilter

All Implemented Interfaces:: NotificationFilter, Serializable

public class AttributeChangeNotificationFilter
extends Object
implements NotificationFilter, Serializable

This class implements of the NotificationFilter interface for the 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.

See Also:: Serialized Form

Constructor Summary

AttributeChangeNotificationFilter()


Method Summary

void disableAllAttributes()
          Disables all the attribute names.

void disableAttribute(String name)
          Disables all the attribute change notifications the attribute name of which equals the specified attribute name to be sent to the listener.

void enableAttribute(String name)
          Enables all the attribute change notifications the attribute name of which equals the specified name to be sent to the listener.

Vector getEnabledAttributes()
          Gets all the enabled attribute names for this filter.

boolean isNotificationEnabled(Notification notification)
          Invoked before sending the specified notification to the listener.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AttributeChangeNotificationFilter

public AttributeChangeNotificationFilter()

Method Detail

isNotificationEnabled

public boolean isNotificationEnabled(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.

Specified by:: isNotificationEnabled in interface NotificationFilter

Parameters:: notification - The attribute change notification to be sent.
Returns:: true if the notification has to be sent to the listener, false otherwise.

enableAttribute

public void enableAttribute(String name)
                     throws IllegalArgumentException

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.

Parameters:: name - The attribute name.
Throws:: IllegalArgumentException - The attribute name parameter is null.

disableAttribute

public void disableAttribute(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.

Parameters:: name - The attribute name.

disableAllAttributes

public void disableAllAttributes()

Disables all the attribute names.

getEnabledAttributes

public Vector getEnabledAttributes()

Gets all the enabled attribute names for this filter.

Returns:: The list containing all the enabled attribute names.