Package jmri.beans

Class ConstrainedBean

java.lang.Object

jmri.beans.UnboundBean

jmri.beans.Bean

jmri.beans.ConstrainedBean

All Implemented Interfaces:

BeanInterface, PropertyChangeFirer, PropertyChangeProvider, VetoableChangeProvider

Direct Known Subclasses:

ConstrainedArbitraryBean, Scale

public abstract class ConstrainedBean
extends Bean
implements VetoableChangeProvider

A Bean with support for VetoableChangeListeners.

Field Summary

Fields

Modifier and Type	Field	Description
protected final VetoableChangeSupport	vetoableChangeSupport

Fields inherited from class jmri.beans.Bean

propertyChangeSupport

Constructor Summary

Constructors

Constructor	Description
ConstrainedBean()

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 vetoable property change on the current thread.
void	fireVetoableChange(String propertyName, boolean oldValue, boolean newValue)	Fire a vetoable property change on the current thread.
void	fireVetoableChange(String propertyName, int oldValue, int newValue)	Fire a vetoable property change on the current thread.
void	fireVetoableChange(String propertyName, Object oldValue, Object newValue)	Fire a vetoable property change on the current thread.
protected Object	getIndexedPropertyOrNull(String key, int index)	Get the indexed property or return null if the index is invalid.
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.
void	setIndexedProperty(String key, int index, Object value)	Set element at index of property array key to value.
void	setProperty(String key, Object value)	Set property key to value.

Methods inherited from class jmri.beans.Bean

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

Methods inherited from class jmri.beans.UnboundBean

getIndexedProperty, getProperty, getPropertyNames, hasIndexedProperty, hasProperty

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

Constructor Details

ConstrainedBean

public ConstrainedBean()

Method Details

setProperty

public void setProperty(String key,
 Object value)

Description copied from class: UnboundBean

Set property key to value.

This implementation calls a write method for the property using JavaBeans introspection.

Specified by:

setProperty in interface BeanInterface

Overrides:

setProperty in class UnboundBean

Parameters:

key - name of the property

value - the value to set the property to

See Also:

• BeanInterface.setProperty(java.lang.String, java.lang.Object)

setIndexedProperty

public void setIndexedProperty(String key,
 int index,
 Object value)

Description copied from class: UnboundBean

Set element at index of property array key to value.

This implementation calls a write method for the indexed property using JavaBeans introspection, and assumes, based on JavaBeans coding patterns, that the write method has the following two parameters in order: index, value.

Specified by:

setIndexedProperty in interface BeanInterface

Overrides:

setIndexedProperty in class UnboundBean

Parameters:

key - name of the property

index - index of the property element to change

value - the value to set the property to

See Also:

• BeanInterface.setIndexedProperty(java.lang.String, int, java.lang.Object)

addVetoableChangeListener

public void addVetoableChangeListener(VetoableChangeListener listener)

Description copied from interface: VetoableChangeProvider

Add a VetoableChangeListener to the listener list.

Specified by:

addVetoableChangeListener in interface VetoableChangeProvider

Parameters:

listener - The VetoableChangeListener to be added

addVetoableChangeListener

public void addVetoableChangeListener(String propertyName,
 VetoableChangeListener listener)

Description copied from interface: VetoableChangeProvider

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()

Description copied from interface: VetoableChangeProvider

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)

Description copied from interface: VetoableChangeProvider

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(VetoableChangeListener listener)

Description copied from interface: VetoableChangeProvider

Remove the specified listener from this object.

Specified by:

removeVetoableChangeListener in interface VetoableChangeProvider

Parameters:

listener - The VetoableChangeListener to remove.

removeVetoableChangeListener

public void removeVetoableChangeListener(String propertyName,
 VetoableChangeListener listener)

Description copied from interface: VetoableChangeProvider

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(PropertyChangeEvent event)
                        throws PropertyVetoException

Fire a vetoable property change on the current thread. Use VetoableChangeSupport.fireVetoableChange(java.beans.PropertyChangeEvent) directly to fire this notification on another thread. If a PropertyVetoException is thrown, ensure the property change does not complete.

Parameters:

event - PropertyChangeEvent to be fired

Throws:

PropertyVetoException - if property update vetoed

fireVetoableChange

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

Fire a vetoable property change on the current thread. Use VetoableChangeSupport.fireVetoableChange(java.lang.String, java.lang.Object, java.lang.Object) directly to fire this notification on another thread. If a PropertyVetoException is thrown, ensure the property change does not complete.

Parameters:

propertyName - property that is about to change

oldValue - old value of the property

newValue - new value of the property

Throws:

PropertyVetoException - if property update vetoed

fireVetoableChange

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

Fire a vetoable property change on the current thread. Use VetoableChangeSupport.fireVetoableChange(java.lang.String, int, int) directly to fire this notification on another thread. If a PropertyVetoException is thrown, ensure the property change does not complete.

Parameters:

propertyName - property that is about to change

oldValue - old value of the property

newValue - new value of the property

Throws:

PropertyVetoException - if property update vetoed

fireVetoableChange

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

Fire a vetoable property change on the current thread. Use VetoableChangeSupport.fireVetoableChange(java.lang.String, boolean, boolean) directly to fire this notification on another thread. If a PropertyVetoException is thrown, ensure the property change does not complete.

Parameters:

propertyName - property that is about to change

oldValue - old value of the property

newValue - new value of the property

Throws:

PropertyVetoException - if property update vetoed

getIndexedPropertyOrNull

protected Object getIndexedPropertyOrNull(String key,
 int index)

Get the indexed property or return null if the index is invalid. Used to get the old value when setting an indexed property where the index may not previously have been set.

Parameters:

key - the property name

index - the index

Returns:

the value at index or null