APIdia Launch Partner
Top Description Fields Constructors Methods
java.beans

public Class PropertyChangeEvent

extends EventObject
Class Inheritance
Known Direct Subclasses
java.beans.IndexedPropertyChangeEvent
Imports
java.io.Serial, java.util.EventObject
A "PropertyChange" event gets delivered whenever a bean changes a "bound" or "constrained" property. A PropertyChangeEvent object is sent as an argument to the PropertyChangeListener and VetoableChangeListener methods.

Normally PropertyChangeEvents are accompanied by the name and the old and new value of the changed property. If the new value is a primitive type (such as int or boolean) it must be wrapped as the corresponding java.lang.* Object type (such as Integer or Boolean).

Null values may be provided for the old and the new values if their true values are not known.

An event source may send a null object as the name to indicate that an arbitrary set of if its properties have changed. In this case the old and new values should also be null.

Since
1.1

Field Summary

Modifier and TypeField and Description
private Object
newValue

New value for property.

private Object
oldValue

Previous value for property.

private Object
propagationId

Propagation ID. May be null.

private String
propertyName

name of the property that changed.

private static final long
serialVersionUID

Hides java.util.EventObject.serialVersionUID.

Use serialVersionUID from JDK 1.7 for interoperability.
Inherited from java.util.EventObject:
source

Constructor Summary

AccessConstructor and Description
public
PropertyChangeEvent(Object
the bean that fired the event
source, String
the programmatic name of the property that was changed
propertyName, Object
the old value of the property
oldValue, Object
the new value of the property
newValue)

Constructs a new PropertyChangeEvent.

Method Summary

Modifier and TypeMethod and Description
pack-priv void
appendTo(StringBuilder sb)

public Object

Returns:

The new value for the property, expressed as an Object. May be null if multiple properties have changed.
getNewValue()

Gets the new value for the property, expressed as an Object.

public Object

Returns:

The old value for the property, expressed as an Object. May be null if multiple properties have changed.
getOldValue()

Gets the old value for the property, expressed as an Object.

public Object

Returns:

the propagationId object associated with a bound/constrained property update.
getPropagationId()

The "propagationId" field is reserved for future use.

public String

Returns:

The programmatic name of the property that was changed. May be null if multiple properties have changed.
getPropertyName()

Gets the programmatic name of the property that was changed.

public void
setPropagationId(Object
The propagationId object for the event.
propagationId)

Sets the propagationId object for the event.

public String

Returns:

a string representation of the object
toString()

Overrides java.util.EventObject.toString.

Returns a string representation of the object.

Inherited from java.util.EventObject:
getSource

Field Detail

newValueback to summary
private Object newValue

New value for property. May be null if not known.

Annotations
@SuppressWarnings:serial
oldValueback to summary
private Object oldValue

Previous value for property. May be null if not known.

Annotations
@SuppressWarnings:serial
propagationIdback to summary
private Object propagationId

Propagation ID. May be null.

Annotations
@SuppressWarnings:serial
See Also
getPropagationId
propertyNameback to summary
private String propertyName

name of the property that changed. May be null, if not known.

serialVersionUIDback to summary
private static final long serialVersionUID

Hides java.util.EventObject.serialVersionUID.

Use serialVersionUID from JDK 1.7 for interoperability.

Annotations
@Serial

Constructor Detail

PropertyChangeEventback to summary
public PropertyChangeEvent(Object source, String propertyName, Object oldValue, Object newValue)

Constructs a new PropertyChangeEvent.

Parameters
source:Object

the bean that fired the event

propertyName:String

the programmatic name of the property that was changed

oldValue:Object

the old value of the property

newValue:Object

the new value of the property

Exceptions
IllegalArgumentException:
if source is null

Method Detail

appendToback to summary
pack-priv void appendTo(StringBuilder sb)
getNewValueback to summary
public Object getNewValue()

Gets the new value for the property, expressed as an Object.

Returns:Object

The new value for the property, expressed as an Object. May be null if multiple properties have changed.

getOldValueback to summary
public Object getOldValue()

Gets the old value for the property, expressed as an Object.

Returns:Object

The old value for the property, expressed as an Object. May be null if multiple properties have changed.

getPropagationIdback to summary
public Object getPropagationId()

The "propagationId" field is reserved for future use. In Beans 1.0 the sole requirement is that if a listener catches a PropertyChangeEvent and then fires a PropertyChangeEvent of its own, then it should make sure that it propagates the propagationId field from its incoming event to its outgoing event.

Returns:Object

the propagationId object associated with a bound/constrained property update.

getPropertyNameback to summary
public String getPropertyName()

Gets the programmatic name of the property that was changed.

Returns:String

The programmatic name of the property that was changed. May be null if multiple properties have changed.

setPropagationIdback to summary
public void setPropagationId(Object propagationId)

Sets the propagationId object for the event.

Parameters
propagationId:Object

The propagationId object for the event.

toStringback to summary
public String toString()

Overrides java.util.EventObject.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object

Annotations
@Override
Since
1.7