java.beans

Class PropertyChangeEvent

Implemented Interfaces:
Serializable
Known Direct Subclasses:
IndexedPropertyChangeEvent

public class PropertyChangeEvent
extends EventObject

PropertyChangeEvents are fired in the PropertyChange and VetoableChange event classes. They represent the old and new values as well as the source Bean. If the old or new value is a primitive type, it must be wrapped in the appropriate wrapper type (java.lang.Integer for int, etc., etc.).

If the old or new values are unknown (although why that would be I do not know), they may be null. Also, if the set of properties itself has changed, the name should be null, and the old and new values may also be null. Right now Sun put in a propagationId, reserved for future use. Read the comments on the constructor and on setPropagationId for more information.

Since:
1.1
See Also:
Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

PropertyChangeEvent(Object source, String propertyName, Object oldVal, Object newVal)
Create a new PropertyChangeEvent.

Method Summary

Object
getNewValue()
Get the property's new value.
Object
getOldValue()
Get the property's old value.
Object
getPropagationId()
Get the propagation ID.
String
getPropertyName()
Get the property name.
void
setPropagationId(Object propagationId)
Set the propagation ID.

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

PropertyChangeEvent

public PropertyChangeEvent(Object source,
                           String propertyName,
                           Object oldVal,
                           Object newVal)
Create a new PropertyChangeEvent. Remember that if you received a PropertyChangeEvent and are sending a new one, you should also set the propagation ID from the old PropertyChangeEvent.
Parameters:
source - the Bean containing the property
propertyName - the property's name
oldVal - the old value of the property
newVal - the new value of the property
Throws:
IllegalArgumentException - if source is null

Method Details

getNewValue

public Object getNewValue()
Get the property's new value. May be null if multiple properties changed.
Returns:
the property's new value

getOldValue

public Object getOldValue()
Get the property's old value. May be null if multiple properties changed.
Returns:
the property's old value

getPropagationId

public Object getPropagationId()
Get the propagation ID. Right now, it is not used for anything.
Returns:
the propagation ID

getPropertyName

public String getPropertyName()
Get the property name. May be null if multiple properties changed.
Returns:
the property name

setPropagationId

public void setPropagationId(Object propagationId)
Set the propagation ID. This is a way for the event to be passed from hand to hand and retain a little extra state. Right now it is unused, but it should be propagated anyway so that future versions of JavaBeans can use it, for God knows what.
Parameters:
propagationId - the propagation ID

PropertyChangeEvent.java -- describes a change in a property Copyright (C) 1998, 2000, 2002, 2005 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.