FileDocCategorySizeDatePackage
PropertyChangeSupport.javaAPI DocJava SE 6 API17742Tue Jun 10 00:25:30 BST 2008java.beans

PropertyChangeSupport

public class PropertyChangeSupport extends Object implements Serializable
This is a utility class that can be used by beans that support bound properties. You can use an instance of this class as a member field of your bean and delegate various work to it. This class is serializable. When it is serialized it will save (and restore) any listeners that are themselves serializable. Any non-serializable listeners will be skipped during serialization.

Fields Summary
private transient sun.awt.EventListenerAggregate
listeners
private Hashtable
children
Hashtable for managing listeners for specific properties. Maps property names to PropertyChangeSupport objects.
private Object
source
The object to be provided as the "source" for any generated events.
private int
propertyChangeSupportSerializedDataVersion
Internal version number
static final long
serialVersionUID
Serialization version ID, so we're compatible with JDK 1.1
Constructors Summary
public PropertyChangeSupport(Object sourceBean)
Constructs a PropertyChangeSupport object.

param
sourceBean The bean to be given as the source for any events.

	if (sourceBean == null) {
	    throw new NullPointerException();
	}
	source = sourceBean;
    
Methods Summary
public synchronized voidaddPropertyChangeListener(java.beans.PropertyChangeListener listener)
Add a PropertyChangeListener to the listener list. The listener is registered for all properties. The same listener object may be added more than once, and will be called as many times as it is added. If listener is null, no exception is thrown and no action is taken.

param
listener The PropertyChangeListener to be added

	if (listener == null) {
	    return;
	}

	if (listener instanceof PropertyChangeListenerProxy) {
	    PropertyChangeListenerProxy proxy =
                   (PropertyChangeListenerProxy)listener;
	    // Call two argument add method.
	    addPropertyChangeListener(proxy.getPropertyName(),
                    (PropertyChangeListener)proxy.getListener());
	} else {
	    if (listeners == null) {
		listeners = new EventListenerAggregate(PropertyChangeListener.class);
	    }
	    listeners.add(listener);
	}
    
public synchronized voidaddPropertyChangeListener(java.lang.String propertyName, java.beans.PropertyChangeListener listener)
Add a PropertyChangeListener for a specific property. The listener will be invoked only when a call on firePropertyChange names that specific property. The same listener object may be added more than once. For each property, the listener will be invoked the number of times it was added for that property. If propertyName or listener is null, no exception is thrown and no action is taken.

param
propertyName The name of the property to listen on.
param
listener The PropertyChangeListener to be added

        if (listener == null || propertyName == null) {
            return;
        }
        if (children == null) {
            children = new java.util.Hashtable();
        }
        PropertyChangeSupport child = (PropertyChangeSupport)children.get(propertyName);
        if (child == null) {
            child = new PropertyChangeSupport(source);
            children.put(propertyName, child);
        }
        child.addPropertyChangeListener(listener);
    
public voidfireIndexedPropertyChange(java.lang.String propertyName, int index, java.lang.Object oldValue, java.lang.Object newValue)
Report a bound indexed property update to any registered listeners.

No event is fired if old and new values are equal and non-null.

This is merely a convenience wrapper around the more general firePropertyChange method that takes {@code PropertyChangeEvent} value.

param
propertyName The programmatic name of the property that was changed.
param
index index of the property element that was changed.
param
oldValue The old value of the property.
param
newValue The new value of the property.
since
1.5

	firePropertyChange(new IndexedPropertyChangeEvent
	    (source, propertyName, oldValue, newValue, index));
    
public voidfireIndexedPropertyChange(java.lang.String propertyName, int index, int oldValue, int newValue)
Report an int bound indexed property update to any registered listeners.

No event is fired if old and new values are equal.

This is merely a convenience wrapper around the more general fireIndexedPropertyChange method which takes Object values.

param
propertyName The programmatic name of the property that was changed.
param
index index of the property element that was changed.
param
oldValue The old value of the property.
param
newValue The new value of the property.
since
1.5

	if (oldValue == newValue) {
	    return;
	}
	fireIndexedPropertyChange(propertyName, index, 
				  new Integer(oldValue), 
				  new Integer(newValue));
    
public voidfireIndexedPropertyChange(java.lang.String propertyName, int index, boolean oldValue, boolean newValue)
Report a boolean bound indexed property update to any registered listeners.

No event is fired if old and new values are equal.

This is merely a convenience wrapper around the more general fireIndexedPropertyChange method which takes Object values.

param
propertyName The programmatic name of the property that was changed.
param
index index of the property element that was changed.
param
oldValue The old value of the property.
param
newValue The new value of the property.
since
1.5

	if (oldValue == newValue) {
	    return;
	}
	fireIndexedPropertyChange(propertyName, index, Boolean.valueOf(oldValue), 
				  Boolean.valueOf(newValue));
    
public voidfirePropertyChange(java.lang.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.

This is merely a convenience wrapper around the more general firePropertyChange method that takes Object values.

param
propertyName The programmatic name of the property that was changed.
param
oldValue The old value of the property.
param
newValue The new value of the property.

	if (oldValue == newValue) {
	    return;
	}
	firePropertyChange(propertyName, Boolean.valueOf(oldValue), Boolean.valueOf(newValue));
    
public voidfirePropertyChange(java.beans.PropertyChangeEvent evt)
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.

param
evt The PropertyChangeEvent object.

	Object oldValue = evt.getOldValue();
	Object newValue = evt.getNewValue();
        String propertyName = evt.getPropertyName();
	if (oldValue != null && newValue != null && oldValue.equals(newValue)) {
	    return;
	}

	if (listeners != null) {
	    Object[] list = listeners.getListenersInternal();
	    for (int i = 0; i < list.length; i++) {
		PropertyChangeListener target = (PropertyChangeListener)list[i];
		target.propertyChange(evt);
	    }
	}

	if (children != null && propertyName != null) {
	    PropertyChangeSupport child = null;
	    child = (PropertyChangeSupport)children.get(propertyName);
	    if (child != null) {
		child.firePropertyChange(evt);
	    }
	}
    
public voidfirePropertyChange(java.lang.String propertyName, java.lang.Object oldValue, java.lang.Object newValue)
Report a 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 {@code PropertyChangeEvent} value.

param
propertyName The programmatic name of the property that was changed.
param
oldValue The old value of the property.
param
newValue The new value of the property.

	if (oldValue != null && newValue != null && oldValue.equals(newValue)) {
	    return;
	}
	firePropertyChange(new PropertyChangeEvent(source, propertyName,
						   oldValue, newValue));
    
public voidfirePropertyChange(java.lang.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.

This is merely a convenience wrapper around the more general firePropertyChange method that takes Object values.

param
propertyName The programmatic name of the property that was changed.
param
oldValue The old value of the property.
param
newValue The new value of the property.

	if (oldValue == newValue) {
	    return;
	}
	firePropertyChange(propertyName, new Integer(oldValue), new Integer(newValue));
    
public synchronized java.beans.PropertyChangeListener[]getPropertyChangeListeners()
Returns an array of all the listeners that were added to the PropertyChangeSupport object with addPropertyChangeListener().

If some listeners have been added with a named property, then the returned array will be a mixture of PropertyChangeListeners and PropertyChangeListenerProxys. If the calling method is interested in distinguishing the listeners then it must test each element to see if it's a PropertyChangeListenerProxy, perform the cast, and examine the parameter.

PropertyChangeListener[] listeners = bean.getPropertyChangeListeners();
for (int i = 0; i < listeners.length; i++) {
if (listeners[i] instanceof PropertyChangeListenerProxy) {
PropertyChangeListenerProxy proxy =
(PropertyChangeListenerProxy)listeners[i];
if (proxy.getPropertyName().equals("foo")) {
// proxy is a PropertyChangeListener which was associated
// with the property named "foo"
}
}
}

see
PropertyChangeListenerProxy
return
all of the PropertyChangeListeners added or an empty array if no listeners have been added
since
1.4

	List returnList = new ArrayList();
     
	// Add all the PropertyChangeListeners 
	if (listeners != null) {
	    returnList.addAll(Arrays.asList(listeners.getListenersInternal()));
	}
	 
	// Add all the PropertyChangeListenerProxys
	if (children != null) {
	    Iterator iterator = children.keySet().iterator();
	    while (iterator.hasNext()) {
		String key = (String)iterator.next();
		PropertyChangeSupport child =
                        (PropertyChangeSupport)children.get(key);
		PropertyChangeListener[] childListeners =
                        child.getPropertyChangeListeners();
		for (int index = childListeners.length - 1; index >= 0;
                        index--) {
		    returnList.add(new PropertyChangeListenerProxy(
                            key, childListeners[index]));
		}
	    }
	}
	return (PropertyChangeListener[])(returnList.toArray(
                new PropertyChangeListener[0]));
    
public synchronized java.beans.PropertyChangeListener[]getPropertyChangeListeners(java.lang.String propertyName)
Returns an array of all the listeners which have been associated with the named property.

param
propertyName The name of the property being listened to
return
all of the PropertyChangeListeners associated with the named property. If no such listeners have been added, or if propertyName is null, an empty array is returned.
since
1.4

        ArrayList returnList = new ArrayList();

        if (children != null && propertyName != null) {
            PropertyChangeSupport support =
                    (PropertyChangeSupport)children.get(propertyName);
            if (support != null) {
                returnList.addAll(
                        Arrays.asList(support.getPropertyChangeListeners()));
            }
        }
        return (PropertyChangeListener[])(returnList.toArray(
                new PropertyChangeListener[0]));
    
public synchronized booleanhasListeners(java.lang.String propertyName)
Check if there are any listeners for a specific property, including those registered on all properties. If propertyName is null, only check for listeners registered on all properties.

param
propertyName the property name.
return
true if there are one or more listeners for the given property

	if (listeners != null && !listeners.isEmpty()) {
	    // there is a generic listener
	    return true;
	}
	if (children != null && propertyName != null) {
	    PropertyChangeSupport child = (PropertyChangeSupport)children.get(propertyName);
	    if (child != null && child.listeners != null) {
		return !child.listeners.isEmpty();
	    }
	}
	return false;
    
private voidreadObject(java.io.ObjectInputStream s)

        s.defaultReadObject();
      
        Object listenerOrNull;
        while (null != (listenerOrNull = s.readObject())) {
	    addPropertyChangeListener((PropertyChangeListener)listenerOrNull);
        }
    
public synchronized voidremovePropertyChangeListener(java.beans.PropertyChangeListener listener)
Remove a PropertyChangeListener from the listener list. This removes a PropertyChangeListener that was registered for all properties. If listener was added more than once to the same event source, it will be notified one less time after being removed. If listener is null, or was never added, no exception is thrown and no action is taken.

param
listener The PropertyChangeListener to be removed

	if (listener == null) {
	    return;
	}

	if (listener instanceof PropertyChangeListenerProxy) {
	    PropertyChangeListenerProxy proxy =
                    (PropertyChangeListenerProxy)listener;
	    // Call two argument remove method.
	    removePropertyChangeListener(proxy.getPropertyName(),
                   (PropertyChangeListener)proxy.getListener());
	} else {
	    if (listeners == null) {
		return;
	    }
	    listeners.remove(listener);
	}
    
public synchronized voidremovePropertyChangeListener(java.lang.String propertyName, java.beans.PropertyChangeListener listener)
Remove a PropertyChangeListener for a specific property. If listener was added more than once to the same event source for the specified property, it will be notified one less time after being removed. If propertyName is null, no exception is thrown and no action is taken. If listener is null, or was never added for the specified property, no exception is thrown and no action is taken.

param
propertyName The name of the property that was listened on.
param
listener The PropertyChangeListener to be removed

        if (listener == null || propertyName == null) {
            return;
        }
        if (children == null) {
            return;
        }
        PropertyChangeSupport child = (PropertyChangeSupport)children.get(propertyName);
        if (child == null) {
            return;
        }
        child.removePropertyChangeListener(listener);
    
private voidwriteObject(java.io.ObjectOutputStream s)

serialData
Null terminated list of PropertyChangeListeners.

At serialization time we skip non-serializable listeners and only serialize the serializable listeners.

        s.defaultWriteObject();

	if (listeners != null) {
	    Object[] list = listeners.getListenersCopy();

	    for (int i = 0; i < list.length; i++) {
	        PropertyChangeListener l = (PropertyChangeListener)list[i];
	        if (l instanceof Serializable) {
	            s.writeObject(l);
	        }
            }
        }
        s.writeObject(null);