Package jmri.beans

Class UnboundArbitraryBean

java.lang.Object

jmri.beans.UnboundBean

jmri.beans.UnboundArbitraryBean

All Implemented Interfaces:

BeanInterface

public abstract class UnboundArbitraryBean
extends UnboundBean

Generic implementation of BeanInterface that supports arbitrary properties defined at runtime.

NOTE This class does not implement PropertyChangeSupport. Subclass Bean if you need to support property change listeners.

Field Summary

Fields

Modifier and Type	Field	Description
protected ArbitraryPropertySupport	arbitraryPropertySupport

Constructor Summary

Constructors

Constructor	Description
UnboundArbitraryBean()

Method Summary

Modifier and Type	Method	Description
java.lang.Object	getIndexedProperty(java.lang.String key, int index)	Get value of element at index of property array key.
java.lang.Object	getProperty(java.lang.String key)	Get the value of property key.
java.util.Set<java.lang.String>	getPropertyNames()	Return a list of property names.
boolean	hasIndexedProperty(java.lang.String key)	Test that a property exists and is indexed.
boolean	hasProperty(java.lang.String key)	Test if a property exists.
void	setIndexedProperty(java.lang.String key, int index, java.lang.Object value)	Set element at index of property array key to value.
void	setProperty(java.lang.String key, java.lang.Object value)	Set property key to value.

Methods inherited from class java.lang.Object

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

Field Detail

arbitraryPropertySupport

protected final ArbitraryPropertySupport arbitraryPropertySupport

Constructor Detail

UnboundArbitraryBean

public UnboundArbitraryBean()

Method Detail

getIndexedProperty

public java.lang.Object getIndexedProperty(java.lang.String key,
                                           int index)

Get value of element at index of property array key.

This implementation calls a read method for the indexed property using JavaBeans introspection, and assumes, based on JavaBeans coding patterns, that the read method has the following parameter: index. Note that this method returns null instead of throwing ArrayIndexOutOfBoundsException if the index is invalid since the Java introspection methods provide no reliable way to get the size of the indexed property.

Specified by:

getIndexedProperty in interface BeanInterface

Overrides:

getIndexedProperty in class UnboundBean

Parameters:

key - Property array to parse.

index - Element to retrieve.

Returns:

value of element or null

getProperty

public java.lang.Object getProperty(java.lang.String key)

Get the value of property key.

If null is a valid (or expected) value for key, you might want to use UnboundBean.hasProperty(java.lang.String) to test that the property exists.

This implementation searches the internal property collection and uses introspection to get the property.

Specified by:

getProperty in interface BeanInterface

Overrides:

getProperty in class UnboundBean

Parameters:

key - Property to retrieve.

Returns:

value of key or null.

See Also:

BeanInterface.getProperty(java.lang.String)

getPropertyNames

public java.util.Set<java.lang.String> getPropertyNames()

Return a list of property names.

This implementation combines the keys in ArbitraryPropertySupport.getPropertyNames() with the results of BeanUtil.getIntrospectedPropertyNames(java.lang.Object).

Specified by:

getPropertyNames in interface BeanInterface

Overrides:

getPropertyNames in class UnboundBean

Returns:

a Set of names

See Also:

BeanInterface.getPropertyNames()

hasProperty

public boolean hasProperty(java.lang.String key)

Test if a property exists.

This implementation searches the internal property collection and uses introspection to get the property.

Specified by:

hasProperty in interface BeanInterface

Overrides:

hasProperty in class UnboundBean

Parameters:

key - Property to inspect.

Returns:

true if property exists

See Also:

BeanInterface.hasProperty(java.lang.String)

hasIndexedProperty

public boolean hasIndexedProperty(java.lang.String key)

Description copied from interface: BeanInterface

Test that a property exists and is indexed.

NOTE Implementing method must not call Bean.hasIndexedProperty(), as doing so will cause a stack overflow. Implementing methods may call Beans.hasIntrospectedIndexedProperty() instead.

Specified by:

hasIndexedProperty in interface BeanInterface

Overrides:

hasIndexedProperty in class UnboundBean

Parameters:

key - name of the property

Returns:

true is property key exists and is indexed

setIndexedProperty

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

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 - Property array to use.

index - Element to write.

value - Value to set.

See Also:

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

setProperty

public void setProperty(java.lang.String key,
                        java.lang.Object value)

Set property key to value.

This implementation checks that a write method is not available for the property using JavaBeans introspection, and stores the property using ArbitraryPropertySupport.setProperty(String, Object) only if a write method does not exist. This implementation also fires a PropertyChangeEvent for the property.

Specified by:

setProperty in interface BeanInterface

Overrides:

setProperty in class UnboundBean

Parameters:

key - Property to use.

value - Value to store.

See Also:

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