Package jmri.beans

Class PropertyChangeSupport

java.lang.Object

jmri.beans.PropertyChangeSupport

All Implemented Interfaces:

PropertyChangeFirer, PropertyChangeProvider

Direct Known Subclasses:

AbstractPowerManager, AbstractProgrammer, AbstractThrottle, Action, Automation, AutomationItem, AutomationManager, DefaultProgrammerManager, DeferringProgrammerManager, LnOpsModeProgrammer, Location, LocationManager, LocoIOData, ProgDebugger, RollingStock, RollingStockAttribute, RollingStockGroup, RollingStockManager, Route, RouteLocation, RouteManager, Schedule, ScheduleItem, ScheduleManager, Setup, Track, Train, TrainManager, TrainSchedule, TrainScheduleManager, TurnoutOperation, VetoableChangeSupport

@ThreadSafe
public class PropertyChangeSupport
extends Object
implements PropertyChangeProvider, PropertyChangeFirer

Implementation of PropertyChangeSupport that can be extended by classes that would normally need to implement the methods of PropertyChangeSupport independently.

This class is designed to support retrofitting an existing class with the PropertyChangeProvider and PropertyChangeFirer interfaces without introducing the complexity of the other implementations of PropertyChangeProvider in this package. When designing new classes, it would be preferable to subclass ArbitraryBean, Bean, or ConstrainedBean depending on the design requirements of the new class.

This class is thread safe.

Field Summary

Fields

Modifier and Type	Field	Description
protected PropertyChangeSupport	propertyChangeSupport	Provide a PropertyChangeSupport helper.

Constructor Summary

Constructors

Constructor	Description
PropertyChangeSupport()

Method Summary

Modifier and Type	Method	Description
void	addPropertyChangeListener(PropertyChangeListener listener)	Add a PropertyChangeListener to the listener list.
void	addPropertyChangeListener(String propertyName, PropertyChangeListener listener)	Add a PropertyChangeListener for a specific property.
void	fireIndexedPropertyChange(String propertyName, int index, boolean oldValue, boolean newValue)	Fire an indexed property change.
void	fireIndexedPropertyChange(String propertyName, int index, int oldValue, int newValue)	Fire an indexed property change.
void	fireIndexedPropertyChange(String propertyName, int index, Object oldValue, Object newValue)	Fire an indexed property change.
void	firePropertyChange(PropertyChangeEvent event)	Fire a property change.
void	firePropertyChange(String propertyName, boolean oldValue, boolean newValue)	Fire a property change.
void	firePropertyChange(String propertyName, int oldValue, int newValue)	Fire a property change.
void	firePropertyChange(String propertyName, Object oldValue, Object newValue)	Fire a property change.
PropertyChangeListener[]	getPropertyChangeListeners()	Get all PropertyChangeListeners currently attached to this object.
PropertyChangeListener[]	getPropertyChangeListeners(String propertyName)	Get all PropertyChangeListeners currently listening to changes to the specified property.
void	removePropertyChangeListener(PropertyChangeListener listener)	Remove the specified listener from this object.
void	removePropertyChangeListener(String propertyName, PropertyChangeListener listener)	Remove the specified listener of the specified property from this object.

Methods inherited from class java.lang.Object

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

Field Details

propertyChangeSupport

protected final PropertyChangeSupport propertyChangeSupport

Provide a PropertyChangeSupport helper.

Constructor Details

PropertyChangeSupport

public PropertyChangeSupport()

Method Details

addPropertyChangeListener

public void addPropertyChangeListener(@CheckForNull PropertyChangeListener listener)

Add a PropertyChangeListener to the listener list.

Specified by:

addPropertyChangeListener in interface PropertyChangeProvider

Parameters:

listener - The PropertyChangeListener to be added

addPropertyChangeListener

public void addPropertyChangeListener(@CheckForNull String propertyName, @CheckForNull PropertyChangeListener listener)

Add a PropertyChangeListener for a specific property.

Specified by:

addPropertyChangeListener in interface PropertyChangeProvider

Parameters:

propertyName - The name of the property to listen on.

listener - The PropertyChangeListener to be added

getPropertyChangeListeners

public PropertyChangeListener[] getPropertyChangeListeners()

Get all PropertyChangeListeners currently attached to this object.

Specified by:

getPropertyChangeListeners in interface PropertyChangeProvider

Returns:

An array of PropertyChangeListeners.

getPropertyChangeListeners

public PropertyChangeListener[] getPropertyChangeListeners(@CheckForNull String propertyName)

Get all PropertyChangeListeners currently listening to changes to the specified property.

Specified by:

getPropertyChangeListeners in interface PropertyChangeProvider

Parameters:

propertyName - the name of the property of interest

Returns:

an array of PropertyChangeListeners

removePropertyChangeListener

public void removePropertyChangeListener(@CheckForNull PropertyChangeListener listener)

Remove the specified listener from this object.

Specified by:

removePropertyChangeListener in interface PropertyChangeProvider

Parameters:

listener - The PropertyChangeListener to remove.

removePropertyChangeListener

public void removePropertyChangeListener(@CheckForNull String propertyName, @CheckForNull PropertyChangeListener listener)

Remove the specified listener of the specified property from this object.

Specified by:

removePropertyChangeListener in interface PropertyChangeProvider

Parameters:

propertyName - The name of the property to stop listening to.

listener - The PropertyChangeListener to remove.

fireIndexedPropertyChange

public void fireIndexedPropertyChange(String propertyName, int index, boolean oldValue, boolean newValue)

Fire an indexed property change. Despite being public due to limitations in Java 8, this method should only be called by the subclasses of implementing classes, as this will become a protected class when JMRI requires Java 11 or newer.

Specified by:

fireIndexedPropertyChange in interface PropertyChangeFirer

Parameters:

propertyName - the programmatic name of the property that was changed

index - the index of the property element that was changed

oldValue - the old value of the property

newValue - the new value of the property

fireIndexedPropertyChange

public void fireIndexedPropertyChange(String propertyName, int index, int oldValue, int newValue)

Fire an indexed property change. Despite being public due to limitations in Java 8, this method should only be called by the subclasses of implementing classes, as this will become a protected class when JMRI requires Java 11 or newer.

Specified by:

fireIndexedPropertyChange in interface PropertyChangeFirer

Parameters:

propertyName - the programmatic name of the property that was changed

index - the index of the property element that was changed

oldValue - the old value of the property

newValue - the new value of the property

fireIndexedPropertyChange

public void fireIndexedPropertyChange(String propertyName, int index, Object oldValue, Object newValue)

Fire an indexed property change. Despite being public due to limitations in Java 8, this method should only be called by the subclasses of implementing classes, as this will become a protected class when JMRI requires Java 11 or newer.

Specified by:

fireIndexedPropertyChange in interface PropertyChangeFirer

Parameters:

propertyName - the programmatic name of the property that was changed

index - the index of the property element that was changed

oldValue - the old value of the property

newValue - the new value of the property

firePropertyChange

public void firePropertyChange(String propertyName, boolean oldValue, boolean newValue)

Fire a property change. Despite being public due to limitations in Java 8, this method should only be called by the subclasses of implementing classes, as this will become a protected class when JMRI requires Java 11 or newer.

Specified by:

firePropertyChange in interface PropertyChangeFirer

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

firePropertyChange

public void firePropertyChange(PropertyChangeEvent event)

Fire a property change. Despite being public due to limitations in Java 8, this method should only be called by the subclasses of implementing classes, as this will become a protected class when JMRI requires Java 11 or newer.

Specified by:

firePropertyChange in interface PropertyChangeFirer

Parameters:

event - the PropertyChangeEvent to be fired

firePropertyChange

public void firePropertyChange(String propertyName, int oldValue, int newValue)

Fire a property change. Despite being public due to limitations in Java 8, this method should only be called by the subclasses of implementing classes, as this will become a protected class when JMRI requires Java 11 or newer.

Specified by:

firePropertyChange in interface PropertyChangeFirer

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

firePropertyChange

public void firePropertyChange(String propertyName, Object oldValue, Object newValue)

Fire a property change. Despite being public due to limitations in Java 8, this method should only be called by the subclasses of implementing classes, as this will become a protected class when JMRI requires Java 11 or newer.

Specified by:

firePropertyChange in interface PropertyChangeFirer

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