org.vizzini.util.event
Class PropertyChangeManager

java.lang.Object
  extended by org.vizzini.util.event.PropertyChangeManager
All Implemented Interfaces:
IPropertyChangeSupport

public class PropertyChangeManager
extends Object
implements IPropertyChangeSupport

Provides a manager of property change listeners and convenience methods for creating property change events.

Since:
v0.1
Version:
v0.2
Author:
Jeffrey M. Thompson

Constructor Summary
PropertyChangeManager(Object sourceBean)
          Construct this object with the given parameter.
 
Method Summary
 void addPropertyChangeListener(PropertyChangeListener listener)
          Add a PropertyChangeListener to the listener list.
 void addPropertyChangeListener(String propertyName, PropertyChangeListener listener)
          Add a PropertyChangeListener for a specific property.
protected  boolean contains(PropertyChangeListener listener)
          Return true if the given listener is already registered.
protected  boolean contains(PropertyChangeListener listener, PropertyChangeListener[] listeners)
          Return true if the given listener is already registered.
protected  boolean contains(String propertyName, PropertyChangeListener listener)
          Return true if the given listener is already registered.
 void firePropertyChange(PropertyChangeEvent event)
          Fire an existing PropertyChangeEvent to any registered listeners.
 void firePropertyChange(String propertyName, boolean oldValue, boolean newValue)
          Report a boolean bound property update to any registered listeners.
 void firePropertyChange(String propertyName, int oldValue, int newValue)
          Report an int bound property update to any registered listeners.
 void firePropertyChange(String propertyName, Object oldValue, Object newValue)
          Report a bound property update to any registered listeners.
 PropertyChangeListener[] getPropertyChangeListeners()
          Returns an array of all the listeners that were added to the PropertyChangeSupport object with addPropertyChangeListener().
 PropertyChangeListener[] getPropertyChangeListeners(String propertyName)
          Returns an array of all the listeners that were added to the PropertyChangeSupport object for the given property name.
 boolean hasListeners(String propertyName)
          Check if there are any listeners for a specific property.
 void removePropertyChangeListener(PropertyChangeListener listener)
          Remove a PropertyChangeListener from the listener list.
 void removePropertyChangeListener(String propertyName, PropertyChangeListener listener)
          Remove a PropertyChangeListener for a specific property.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PropertyChangeManager

public PropertyChangeManager(Object sourceBean)
Construct this object with the given parameter.

Parameters:
sourceBean - The source for events.
Throws:
NullPointerException - if sourceBean is null.
Since:
v0.1
Method Detail

getPropertyChangeListeners

public PropertyChangeListener[] getPropertyChangeListeners(String propertyName)
Returns an array of all the listeners that were added to the PropertyChangeSupport object for the given property name.

Since:
v0.2

getPropertyChangeListeners

public PropertyChangeListener[] getPropertyChangeListeners()
Returns an array of all the listeners that were added to the PropertyChangeSupport object with addPropertyChangeListener().

Specified by:
getPropertyChangeListeners in interface IPropertyChangeSupport
Since:
v0.1

addPropertyChangeListener

public void addPropertyChangeListener(PropertyChangeListener listener)
Add a PropertyChangeListener to the listener list. The listener is registered for all properties. This method will only add the listener if it is not already registered.

Specified by:
addPropertyChangeListener in interface IPropertyChangeSupport
Parameters:
listener - The PropertyChangeListener to be added.
Since:
v0.1

addPropertyChangeListener

public void addPropertyChangeListener(String propertyName,
                                      PropertyChangeListener listener)
Add a PropertyChangeListener for a specific property. The listener will be invoked only when a call on firePropertyChange names that specific property. This method will only add the listener if it is not already registered.

Specified by:
addPropertyChangeListener in interface IPropertyChangeSupport
Parameters:
propertyName - The name of the property to listen on.
listener - The PropertyChangeListener to be added.
Since:
v0.1

firePropertyChange

public void firePropertyChange(PropertyChangeEvent event)
Fire an existing PropertyChangeEvent to any registered listeners. No event is fired if the given event's old and new values are equal and non-null.

Specified by:
firePropertyChange in interface IPropertyChangeSupport
Parameters:
event - The PropertyChangeEvent object.
Since:
v0.1

firePropertyChange

public void firePropertyChange(String propertyName,
                               boolean oldValue,
                               boolean newValue)
Report a boolean bound property update to any registered listeners. No event is fired if old and new are equal and non-null. This is merely a convenience wrapper around the more general firePropertyChange method that takes Object values.

Specified by:
firePropertyChange in interface IPropertyChangeSupport
Parameters:
propertyName - The programmatic name of the property that was changed.
oldValue - The old value of the property.
newValue - The new value of the property.
Since:
v0.1

firePropertyChange

public void firePropertyChange(String propertyName,
                               int oldValue,
                               int newValue)
Report an int bound property update to any registered listeners. No event is fired if old and new are equal and non-null. This is merely a convenience wrapper around the more general firePropertyChange method that takes Object values.

Specified by:
firePropertyChange in interface IPropertyChangeSupport
Parameters:
propertyName - The programmatic name of the property that was changed.
oldValue - The old value of the property.
newValue - The new value of the property.
Since:
v0.1

firePropertyChange

public void firePropertyChange(String propertyName,
                               Object oldValue,
                               Object newValue)
Report a bound property update to any registered listeners. No event is fired if old and new are equal and non-null.

Specified by:
firePropertyChange in interface IPropertyChangeSupport
Parameters:
propertyName - The programmatic name of the property that was changed.
oldValue - The old value of the property.
newValue - The new value of the property.
Since:
v0.1

hasListeners

public boolean hasListeners(String propertyName)
Check if there are any listeners for a specific property.

Specified by:
hasListeners in interface IPropertyChangeSupport
Parameters:
propertyName - The property name.
Returns:
true if there are ore or more listeners for the given property.
Since:
v0.1

removePropertyChangeListener

public void removePropertyChangeListener(PropertyChangeListener listener)
Remove a PropertyChangeListener from the listener list. This removes a PropertyChangeListener that was registered for all properties.

Specified by:
removePropertyChangeListener in interface IPropertyChangeSupport
Parameters:
listener - The PropertyChangeListener to be removed.
Since:
v0.1

removePropertyChangeListener

public void removePropertyChangeListener(String propertyName,
                                         PropertyChangeListener listener)
Remove a PropertyChangeListener for a specific property.

Specified by:
removePropertyChangeListener in interface IPropertyChangeSupport
Parameters:
propertyName - The name of the property that was listened on.
listener - The PropertyChangeListener to be removed.
Since:
v0.1

contains

protected boolean contains(String propertyName,
                           PropertyChangeListener listener)
Return true if the given listener is already registered.

Since:
v0.2

contains

protected boolean contains(PropertyChangeListener listener)
Return true if the given listener is already registered.

Since:
v0.2

contains

protected boolean contains(PropertyChangeListener listener,
                           PropertyChangeListener[] listeners)
Return true if the given listener is already registered.

Since:
v0.2


Copyright 2007 Vizzini.org. All Rights Reserved. 2007.12.25.03.00.02