Package jmri.beans

Class Bean

java.lang.Object

jmri.beans.UnboundBean

jmri.beans.Bean

All Implemented Interfaces:

BeanInterface, PropertyChangeFirer, PropertyChangeProvider

Direct Known Subclasses:

AbstractPreferencesManager, AbstractServerPreferences, ArbitraryBean, ConstrainedBean, DefaultShutDownManager, DefaultSystemConnectionMemo, EcosLocoAddress, EditorManager, FileUtilSupport, GuiLafPreferencesManager, IssueReport, JmriUserPreferencesManager, JsonConsistManager, JsonServerPreferences, LayoutTrackExpectedState, NamedBeanExpectedValue, Pool, PreferencesBean, ProfileManager, RosterGroup, SignalSpeedMap, StartupActionModelUtil, SystemConnectionMemoManager, SystemConsolePreferencesManager

public abstract class Bean
extends UnboundBean
implements PropertyChangeFirer, PropertyChangeProvider

Generic implementation of BeanInterface with a complete implementation of PropertyChangeSupport.

See the PropertyChangeSupport documentation for complete documentation of those methods.

This class is thread safe.

See Also:

PropertyChangeSupport

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Bean()	Create a bean that notifies property change listeners on the thread the event was generated on.
protected	Bean(boolean notifyOnEDT)	Create a bean.

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.
boolean	isNotifyOnEDT()	Is this Bean assuring that all property change listeners will be notified on the EDT?
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 jmri.beans.UnboundBean

getIndexedProperty, getProperty, getPropertyNames, hasIndexedProperty, hasProperty, setIndexedProperty, setProperty

Methods inherited from class java.lang.Object

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

Field Details

propertyChangeSupport

protected final SwingPropertyChangeSupport propertyChangeSupport

Provide a PropertyChangeSupport helper.

Constructor Details

Bean

protected Bean()

Create a bean that notifies property change listeners on the thread the event was generated on.

Bean

protected Bean(boolean notifyOnEDT)

Create a bean.

Parameters:

notifyOnEDT - true to notify property change listeners on the EDT; false to notify listeners on the thread the event was generated on (which may or may not be the EDT)

Method Details

addPropertyChangeListener

public void addPropertyChangeListener(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(String propertyName, 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

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

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(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(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(String propertyName, 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.

isNotifyOnEDT

public boolean isNotifyOnEDT()

Is this Bean assuring that all property change listeners will be notified on the EDT?

Returns:

true if notifying listeners of events on the EDT; false if notifying listeners on the thread that the event was generated on (which may or may not be the EDT)