Package jmri.beans

Class VetoableChangeSupport

java.lang.Object

jmri.beans.PropertyChangeSupport

jmri.beans.VetoableChangeSupport

All Implemented Interfaces:

PropertyChangeFirer, PropertyChangeProvider, VetoableChangeFirer, VetoableChangeProvider

Direct Known Subclasses:

AbstractManager, AbstractProxyManager, EntryExitPairs

@ThreadSafe
public class VetoableChangeSupport
extends PropertyChangeSupport
implements VetoableChangeProvider, VetoableChangeFirer

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

This class is designed to support retrofitting an existing class with the PropertyChangeProvider, PropertyChangeFirer, VetoableChangeProvider, and VetoableChangeFirer 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 VetoableChangeSupport	vetoableChangeSupport	Provide a VetoableChangeSupport helper.

Fields inherited from class jmri.beans.PropertyChangeSupport

propertyChangeSupport

Constructor Summary

Constructors

Constructor	Description
VetoableChangeSupport()

Method Summary

Modifier and Type	Method	Description
void	addVetoableChangeListener(VetoableChangeListener listener)	Add a VetoableChangeListener to the listener list.
void	addVetoableChangeListener(String propertyName, VetoableChangeListener listener)	Add a VetoableChangeListener for a specific property.
void	fireVetoableChange(PropertyChangeEvent event)	Fire a property change.
void	fireVetoableChange(String propertyName, boolean oldValue, boolean newValue)	Fire a property change.
void	fireVetoableChange(String propertyName, int oldValue, int newValue)	Fire a property change.
void	fireVetoableChange(String propertyName, Object oldValue, Object newValue)	Fire a property change.
VetoableChangeListener[]	getVetoableChangeListeners()	Get all VetoableChangeListeners currently attached to this object.
VetoableChangeListener[]	getVetoableChangeListeners(String propertyName)	Get all VetoableChangeListeners currently listening to changes to the specified property.
void	removeVetoableChangeListener(VetoableChangeListener listener)	Remove the specified listener from this object.
void	removeVetoableChangeListener(String propertyName, VetoableChangeListener listener)	Remove the specified listener of the specified property from this object.

Methods inherited from class jmri.beans.PropertyChangeSupport

addPropertyChangeListener, addPropertyChangeListener, fireIndexedPropertyChange, fireIndexedPropertyChange, fireIndexedPropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getPropertyChangeListeners, getPropertyChangeListeners, removePropertyChangeListener, removePropertyChangeListener

Methods inherited from class java.lang.Object

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

Field Details

vetoableChangeSupport

protected final VetoableChangeSupport vetoableChangeSupport

Provide a VetoableChangeSupport helper.

Constructor Details

VetoableChangeSupport

public VetoableChangeSupport()

Method Details

addVetoableChangeListener

public void addVetoableChangeListener(@CheckForNull VetoableChangeListener listener)

Add a VetoableChangeListener to the listener list.

Specified by:

addVetoableChangeListener in interface VetoableChangeProvider

Parameters:

listener - The VetoableChangeListener to be added

addVetoableChangeListener

public void addVetoableChangeListener(@CheckForNull String propertyName, @CheckForNull VetoableChangeListener listener)

Add a VetoableChangeListener for a specific property.

Specified by:

addVetoableChangeListener in interface VetoableChangeProvider

Parameters:

propertyName - The name of the property to listen on.

listener - The VetoableChangeListener to be added

getVetoableChangeListeners

public VetoableChangeListener[] getVetoableChangeListeners()

Get all VetoableChangeListeners currently attached to this object.

Specified by:

getVetoableChangeListeners in interface VetoableChangeProvider

Returns:

An array of VetoableChangeListeners.

getVetoableChangeListeners

public VetoableChangeListener[] getVetoableChangeListeners(String propertyName)

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

Specified by:

getVetoableChangeListeners in interface VetoableChangeProvider

Parameters:

propertyName - The name of the property of interest

Returns:

An array of VetoableChangeListeners.

removeVetoableChangeListener

public void removeVetoableChangeListener(@CheckForNull VetoableChangeListener listener)

Remove the specified listener from this object.

Specified by:

removeVetoableChangeListener in interface VetoableChangeProvider

Parameters:

listener - The VetoableChangeListener to remove.

removeVetoableChangeListener

public void removeVetoableChangeListener(@CheckForNull String propertyName, @CheckForNull VetoableChangeListener listener)

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

Specified by:

removeVetoableChangeListener in interface VetoableChangeProvider

Parameters:

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

listener - The VetoableChangeListener to remove.

fireVetoableChange

public void fireVetoableChange(String propertyName, boolean oldValue, boolean newValue) throws PropertyVetoException

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:

fireVetoableChange in interface VetoableChangeFirer

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

Throws:

PropertyVetoException - if one of listeners vetoes the property update

fireVetoableChange

public void fireVetoableChange(PropertyChangeEvent event) throws PropertyVetoException

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:

fireVetoableChange in interface VetoableChangeFirer

Parameters:

event - the PropertyChangeEvent to be fired

Throws:

PropertyVetoException - if one of listeners vetoes the property update

fireVetoableChange

public void fireVetoableChange(String propertyName, int oldValue, int newValue) throws PropertyVetoException

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:

fireVetoableChange in interface VetoableChangeFirer

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

Throws:

PropertyVetoException - if one of listeners vetoes the property update

fireVetoableChange

public void fireVetoableChange(String propertyName, Object oldValue, Object newValue) throws PropertyVetoException

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:

fireVetoableChange in interface VetoableChangeFirer

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

Throws:

PropertyVetoException - if one of listeners vetoes the property update