com.solacesystems.common.property

Class Property<T>

java.lang.Object

com.solacesystems.common.property.Property<T>

All Implemented Interfaces:

PropertySourceChangeListener<T>, VetoablePropertySourceChangeListener<T>, Cloneable

public class Property<T>
extends Object
implements PropertySourceChangeListener<T>, VetoablePropertySourceChangeListener<T>, Cloneable

Field Summary

Fields

Modifier and Type	Field and Description
static String	ANONYMOUS_SOURCE
static String	DEFAULT_SOURCE
static String	NON_PRINTABLE_VALUE_STRING

Constructor Summary

Constructors

Constructor and Description
Property(Object id)
Property(Object id, PropertySource<T>... sources)
Property(Object id, T defaultValue)
Property(Object id, T defaultValue, boolean trimStrings, PropertySource<T>... sources)
Property(Object id, T defaultValue, PropertySource<T>... sources)
Property(Property<T> property) Deep Copy Constructor

Method Summary

Modifier and Type	Method and Description
void	addAllSources(Collection<PropertySource<T>> sources)
void	addListener(PropertyChangeListener<T> listener)
void	addSource(PropertySource<T> source)
void	addSources(PropertySource<T>... sources)
void	addVetoableListener(VetoablePropertySourceChangeListener<T> listener)
Object	clone()
T	getDefaultValue()
String	getId()
PropertySource<T>	getMaster() Returns the highest priority property source that has been set, or null if none of the sources are set.
Class<?>	getParameterizedClass()
PropertySource<T>	getSource(String name)
Collection<String>	getSourceNames()
Collection<PropertySource<T>>	getSources()
HashMap<String,Object>	getSourceUserDataMap(String name)
T	getSourceValue(String name)
boolean	getTrimStrings()
HashMap<String,Object>	getUserDataMap()
T	getValue()
void	initialize()
boolean	isPrintable()
boolean	isSet() Returns true if one of the property sources has been set.
static String	mapToString(Map<String,Property<?>> propertyMap)
void	propertySourceChanged(PropertySourceChangeEvent<T> event)
void	removeListener(PropertyChangeListener<T> listener)
void	removeVetoableListener(VetoablePropertySourceChangeListener<T> listener)
void	setDefaultValue(T value)
void	setObjectValue(Object value) Only to be used with a single sourced property.
void	setPrintable(boolean printable)
void	setSourceUserDataMap(String name, HashMap<String,Object> map)
void	setSourceValue(String name, T value)
void	setTrimStrings(boolean trimStrings)
void	setType(Class<?> type)
void	setUserDataMap(HashMap<String,Object> map)
void	setValue(T value) Only to be used with a single sourced property.
String	toKeyValueString()
String	toString()
String	toString(boolean inclID)
void	vetoablePropertySourceChanged(PropertySourceChangeEvent<T> event)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

ANONYMOUS_SOURCE

public static final String ANONYMOUS_SOURCE

See Also:

Constant Field Values

DEFAULT_SOURCE

public static final String DEFAULT_SOURCE

See Also:

Constant Field Values

NON_PRINTABLE_VALUE_STRING

public static final String NON_PRINTABLE_VALUE_STRING

See Also:

Constant Field Values

Constructor Detail

Property

public Property(Property<T> property)

Deep Copy Constructor

Parameters:

property - Property to be copied.

Property

public Property(Object id)

Property

public Property(Object id,
                T defaultValue)

Property

public Property(Object id,
                PropertySource<T>... sources)

Property

public Property(Object id,
                T defaultValue,
                PropertySource<T>... sources)

Property

public Property(Object id,
                T defaultValue,
                boolean trimStrings,
                PropertySource<T>... sources)

Method Detail

getId

public String getId()

getDefaultValue

public T getDefaultValue()

setDefaultValue

public void setDefaultValue(T value)

setTrimStrings

public void setTrimStrings(boolean trimStrings)

getTrimStrings

public boolean getTrimStrings()

setPrintable

public void setPrintable(boolean printable)

isPrintable

public boolean isPrintable()

addListener

public void addListener(PropertyChangeListener<T> listener)

removeListener

public void removeListener(PropertyChangeListener<T> listener)

addVetoableListener

public void addVetoableListener(VetoablePropertySourceChangeListener<T> listener)

removeVetoableListener

public void removeVetoableListener(VetoablePropertySourceChangeListener<T> listener)

addSource

public void addSource(PropertySource<T> source)

addSources

public void addSources(PropertySource<T>... sources)

addAllSources

public void addAllSources(Collection<PropertySource<T>> sources)

initialize

public void initialize()
                throws PropertyVetoException,
                       PropertyConversionException

Throws:

PropertyVetoException

PropertyConversionException

getSources

public Collection<PropertySource<T>> getSources()

getSourceNames

public Collection<String> getSourceNames()

getSource

public PropertySource<T> getSource(String name)

getUserDataMap

public HashMap<String,Object> getUserDataMap()

setUserDataMap

public void setUserDataMap(HashMap<String,Object> map)

getSourceValue

public T getSourceValue(String name)

setSourceValue

public void setSourceValue(String name,
                           T value)
                    throws PropertyVetoException

Throws:

PropertyVetoException

getSourceUserDataMap

public HashMap<String,Object> getSourceUserDataMap(String name)

setSourceUserDataMap

public void setSourceUserDataMap(String name,
                                 HashMap<String,Object> map)

isSet

public boolean isSet()

Returns true if one of the property sources has been set. This will return false if the default value is the only value that's been set (the master is the default value).

Returns:

True if one of the property sources has been set.

getValue

public T getValue()

getMaster

public PropertySource<T> getMaster()

Returns the highest priority property source that has been set, or null if none of the sources are set.

Returns:

The master property source.

setValue

public void setValue(T value)
              throws PropertyVetoException,
                     PropertyConversionException

Only to be used with a single sourced property. If multiple sources, the sources should be set directly.

Parameters:

value, - the value

Throws:

PropertyVetoException - on error

PropertyConversionException - on error

setObjectValue

public void setObjectValue(Object value)
                    throws PropertyConversionException,
                           PropertyVetoException

Only to be used with a single sourced property. If multiple sources, the sources should be set directly.

Parameters:

value, - the value

Throws:

PropertyConversionException - on error

PropertyVetoException - on error

propertySourceChanged

public void propertySourceChanged(PropertySourceChangeEvent<T> event)

Specified by:

propertySourceChanged in interface PropertySourceChangeListener<T>

vetoablePropertySourceChanged

public void vetoablePropertySourceChanged(PropertySourceChangeEvent<T> event)
                                   throws PropertyVetoException

Specified by:

vetoablePropertySourceChanged in interface VetoablePropertySourceChangeListener<T>

Throws:

PropertyVetoException

setType

public void setType(Class<?> type)

getParameterizedClass

public Class<?> getParameterizedClass()

clone

public Object clone()
             throws CloneNotSupportedException

Overrides:

clone in class Object

Throws:

CloneNotSupportedException

toKeyValueString

public String toKeyValueString()

toString

public String toString()

Overrides:

toString in class Object

toString

public String toString(boolean inclID)

mapToString

public static String mapToString(Map<String,Property<?>> propertyMap)