dk.heick.properties

Class Property<T>

java.lang.Object

dk.heick.properties.Property<T>

All Implemented Interfaces:

Serializable, Comparable<Property<T>>

public class Property<T>
extends Object
implements Comparable<Property<T>>, Serializable

The main Property class. Contains a property, it has four elements:

• name : the name of property.
• type : the type that the value string can be converted too.
• allowNull : Is null allowed as a valid value. (default=false)
• readonly : Is the property readonly. (default=false)
• description : the description of property, if the value starts with "$" it is assume that it is the key for a I18N lookup for the property description.
• io : the IO where from we retrieve the value. This will be assigned at runtime.
Additionally a Property can have a list of PropertyChangeListener's, which is fire before and after a property is changed.
you have to add these in your PropertyCollection constructor or preValidation method.
All PropertyChangeListener have a ID this to ensure that a PropertyChangeListener only can be fired once per Property

Since:

1.0

Author:

Frederik Heick

See Also:

PropertyChangeListener, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	I18N_DESCRIPTION_INDICATOR
static String	I18N_PREFIX

Constructor Summary

Constructors

Constructor and Description
Property(String name, PropertyType<T> type) The constructor.
Property(String name, PropertyType<T> type, boolean nullAllowed) The constructor.
Property(String name, PropertyType<T> type, boolean nullAllowed, boolean readonly) The constructor.
Property(String name, PropertyType<T> type, boolean nullAllowed, boolean readonly, String description) The constructor with all the different paramenters.
Property(String name, PropertyType<T> type, String description) The constructor.

Method Summary

Modifier and Type	Method and Description
boolean	addPropertyChangeListener(PropertyChangeListener listener) Adds a PropertyChangeListener to the Property changeListener list.
int	compareTo(Property o) Compare on names
boolean	equals(Object obj) Two Property objects are equal if their names are equal.
Collection<PropertyChangeListener>	getChangeListeners() Get all the PropertyChangeListeners in a Collections.unmodifiableCollection.
String	getDescription() Gets the description of property if any is set, if description is null it will try to retrieved the description from the localizer.
String	getI18NName() Getting the I18N name for the property description, if you choose not to enter a description but instead using a I18N framework.
PropertyIO	getIo() The io from where the property gets and set the value of the property.
org.apache.commons.logging.Log	getLogger() Gets the logger.
String	getName() Gets the name of property.
PropertyType<T>	getType() Gets the type of property.
T	getTypedValue() Get the typed value of the property value.
String	getValue() Gets the value of property through the PropertyIO.
int	hashCode() Hashcode of the name.
boolean	isDefined() Determines if the Property is defined in the PropertyIO source.
boolean	isDescriptionI18NKey() If the description starts with "$", then it is assume that the description is actual the key for ResouceBundle entry.
boolean	isNullAllowed() Is the property allowed to have a undefined value and/or return null.
boolean	isReadonly() Determines if this property is specific set to be read only.
boolean	isValid() A convenience method for just determining if a Property is valid or not.
void	reload() Resets the cache of value, which is stored in the instance of the PropertyType for this Property.
void	removeAllPropertyChangeListeners() Remove all PropertyChangeListeners from the Property.
boolean	removePropertyChangeListener(PropertyChangeListener listener) Removes a PropertyChangeListener from the Property changelist.
void	setDescription(String description) Sets description of the Property.
void	setIo(PropertyIO io) Sets the PropertyIO for the property.
void	setNullAllowed(boolean value) Sets if null is allowed as value for the Property.
void	setReadonly(boolean readonly) Sets the property to be read only or not.
void	setTypedValue(T value) Sets the value (T) for the Property via the PropertyIO.
void	setValue(String value) Sets the value (String) for the Property via the PropertyIO.
String	toString()
void	validate() Validates the value through the PropertyType validation.
PropertyValidationVO	validation() Wrappeds the validate method into a PropertyValidationVO.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

I18N_PREFIX

public static final String I18N_PREFIX

See Also:

Constant Field Values

I18N_DESCRIPTION_INDICATOR

public static final String I18N_DESCRIPTION_INDICATOR

See Also:

Constant Field Values

Constructor Detail

Property

public Property(String name,
                PropertyType<T> type)
         throws NullPointerException

The constructor. PropertyIO shall be assigned at runtime.

Parameters:

name - the name of the property

type - the type of the property, which extends PropertyType

Throws:

NullPointerException - if either name or type is null.

See Also:

PropertyType

Property

public Property(String name,
                PropertyType<T> type,
                boolean nullAllowed)
         throws NullPointerException

The constructor. PropertyIO shall be assigned at runtime.

Parameters:

name - the name of the property

type - the type of the property, which extends PropertyType

nullAllowed - is the property allowed to have a undefined value and/or return null.

Throws:

NullPointerException - if either name or type is null.

See Also:

PropertyType

Property

public Property(String name,
                PropertyType<T> type,
                boolean nullAllowed,
                boolean readonly)
         throws NullPointerException

The constructor. PropertyIO shall be assigned at runtime.

Parameters:

name - the name of the property

type - the type of the property, which extends PropertyType

nullAllowed - is the property allowed to have a undefined value and/or return null.

readonly - is the property is read only or not.

Throws:

NullPointerException - if either name or type is null.

See Also:

PropertyType

Property

public Property(String name,
                PropertyType<T> type,
                String description)
         throws NullPointerException

The constructor. PropertyIO shall be assigned at runtime.

Parameters:

name - the name of the property

type - the type of the property, which extends PropertyType

description - the description of the Property.

Throws:

NullPointerException - if either name or type is null.

See Also:

PropertyType

Property

public Property(String name,
                PropertyType<T> type,
                boolean nullAllowed,
                boolean readonly,
                String description)
         throws NullPointerException

The constructor with all the different paramenters.

Parameters:

name - the name of the property.

type - the type of the property, which extends PropertyType.

nullAllowed - is the property allowed to have a undefined value and/or return null.

readonly - is the property is read only or not.

description - the description of the Property.

Throws:

NullPointerException - if either name or type is null.

See Also:

PropertyType

Method Detail

getName

public final String getName()

Gets the name of property.

Returns:

the name

getDescription

public final String getDescription()

Gets the description of property if any is set, if description is null it will try to retrieved the description from the localizer.
If the description string starts "$" it is assumed that the description value is a key for ResourceBundle entry, and it will try to retrive it. Using the "getPropertyDescriptionLocalizer" with the key "getI18NName()", if no localizer is set then null is returned.

Returns:

the description either set or retrieved through description localizer.

Since:

1.8

See Also:

getI18NName(), PropertyFrameworkGlobals.getPropertyDescriptionLocalizer(), Localizer

isDescriptionI18NKey

public final boolean isDescriptionI18NKey()

If the description starts with "$", then it is assume that the description is actual the key for ResouceBundle entry.

Returns:

true if the description starts with "$" (trimmed), otherwise false.

setDescription

public final void setDescription(String description)

Sets description of the Property.

Parameters:

description - the description.

getType

public final PropertyType<T> getType()

Gets the type of property.

Returns:

the type

See Also:

PropertyType

getIo

public final PropertyIO getIo()

The io from where the property gets and set the value of the property.

Returns:

the IO.

See Also:

PropertyIO

getI18NName

public final String getI18NName()

Getting the I18N name for the property description, if you choose not to enter a description but instead using a I18N framework.
If the description starts with "$", then it is assume that the description is actual the key for ResouceBundle entry. See "PropertyUtils.getI18NName(prefix,name)" for more details.
The prefix is "jhpt.property.i18n".

Examples:

• myapp.mail.hostname => jhpt.property.i18n.myapp.mail.hostname

Returns:

the i18n resource name string to get description from I18N framework, if the description starts with $

Since:

1.8

See Also:

I18N_PREFIX, PropertyUtils.getI18NName(String, String)

setIo

public final void setIo(PropertyIO io)

Sets the PropertyIO for the property.
When this is set, the propertyType is set with this IO.

Parameters:

io - the IO.

See Also:

PropertyIO

getValue

public final String getValue()

Gets the value of property through the PropertyIO.
This will not use the default value in the property type if the value do not exists.
Remember that the value will be parsed by the StringUtils.replaceInlinedProperties(String) method, to replace ${name} where name can either be a System.getProperty(String) or System.getenv(String).


Remember that the value will be parsed by the StringUtils.removeValueQuotes(String) method, to replace ${name} where name can either be a System.getProperty(String) or System.getenv(String).

This method invokes the method PropertyType.postGetValueProcessing(name,value). After the two methods above.

Returns:

the value of property. If the PropertyType is of DerivedPropertyType than null is returned.

Throws:

NullPointerException - if IO is null.

See Also:

PropertyIO, StringUtils.replaceInlinedProperties(String), StringUtils.removeValueQuotes(String), PropertyType.postGetValueProcessing(String, String, boolean)

getTypedValue

public final T getTypedValue()

Get the typed value of the property value. This is converted through the propertyType.
This will return a typed value through the PropertyType method toType(name,value).
The rules are:

• If the string value is null, than the Property is undefined.
• If a default value is defined than this is returned otherwise null is returned.
• If the string value is NOT null, than the Property is defined.
• If PropertyType can successfully convert the value, than the converted value is returned.
• If PropertyType can NOT convert the value, than null is returned.

Returns:

the converted String value. See method description.

See Also:

PropertyIO, PropertyType, PropertyType.toType(String, String), getValue()

setValue

public final void setValue(String value)
                    throws PropertyException

Sets the value (String) for the Property via the PropertyIO.
This string value is validated through the PropertyType.
It also reset cache if this is used.
If any PropertyChangeListeners is added to the Property, the call in this method.

Parameters:

value - of type string

Throws:

PropertyException - if value fails validation or PropertyIO fails the setting of the value.

See Also:

PropertyIO.setValue(String, String), PropertyType.validate(String, String)

setTypedValue

public final void setTypedValue(T value)
                         throws PropertyException

Sets the value (T) for the Property via the PropertyIO.
This value is validated through the PropertyType.
It also reset cache if this is used.
If any PropertyChangeListeners is added to the Property, the call in this method.

Parameters:

value - of type T

Throws:

PropertyException - if value fails validation or PropertyIO fails the setting of the value.

See Also:

PropertyIO.setValue(String, String), PropertyType.validate(String, String)

validate

public final void validate()
                    throws PropertyException

Validates the value through the PropertyType validation.
It also validate the constraints of the PropertyType.

Throws:

PropertyException - if the value type isnt valid.

See Also:

PropertyType.validateConstraints(String)

validation

public final PropertyValidationVO validation()

Wrappeds the validate method into a PropertyValidationVO.
This is to facilitate the ability the recieve a list of a property validations instead of the first that wasnt valid.

Returns:

the PropertyValidationVO of the validated property.

See Also:

PropertyValidationVO

isValid

public final boolean isValid()

A convenience method for just determining if a Property is valid or not.
If both the stored values and the default value is invalid.

Returns:

true if property value/default is valid, otherwise false.

See Also:

PropertyValidationVO.isValid()

reload

public final void reload()

Resets the cache of value, which is stored in the instance of the PropertyType for this Property.

toString

public final String toString()

Overrides:

toString in class Object

hashCode

public final int hashCode()

Hashcode of the name.

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Two Property objects are equal if their names are equal.

Overrides:

equals in class Object

compareTo

public final int compareTo(Property o)

Compare on names

Specified by:

compareTo in interface Comparable<Property<T>>

isReadonly

public final boolean isReadonly()

Determines if this property is specific set to be read only.
This is default set to false, and normally handled by the PropertyIO.

Returns:

true if the PropertyIO is not null and PropertyIO.isReadonly() is true, otherwise return the property's own value of read only attribute which can be set individually.

See Also:

getIo(), PropertyIO.isReadonly()

isNullAllowed

public final boolean isNullAllowed()

Is the property allowed to have a undefined value and/or return null.

Returns:

true if null is allowed as valid value.

setNullAllowed

public final void setNullAllowed(boolean value)

Sets if null is allowed as value for the Property.

Parameters:

value - if null is allowed as value or not.

Since:

1.9

setReadonly

public final void setReadonly(boolean readonly)

Sets the property to be read only or not.
This normally handled by the PropertyIO, but provides the possibility to set individual property to be read only if so desired.
This is typically set in the collection constructor for the property

Parameters:

readonly - if the property should be read only or not.

isDefined

public final boolean isDefined()

Determines if the Property is defined in the PropertyIO source.

Returns:

true if getValue() differs from null, otherwise false.

Since:

1.2

getLogger

public final org.apache.commons.logging.Log getLogger()

Gets the logger.

Returns:

the commons logger

addPropertyChangeListener

public final boolean addPropertyChangeListener(PropertyChangeListener listener)
                                        throws NullPointerException

Adds a PropertyChangeListener to the Property changeListener list.
Note:
Before version 2.0 every PropertyChangeListener had a ID which had to be unique. This is no longer so.

Parameters:

listener - the listener to be added.

Returns:

true if the listener was added successfully, otherwise false, if it listener is null.

Throws:

NullPointerException - if listener was null.

Since:

1.6

removePropertyChangeListener

public final boolean removePropertyChangeListener(PropertyChangeListener listener)
                                           throws NullPointerException

Removes a PropertyChangeListener from the Property changelist.

Parameters:

listener - the PropertyChangeListener to be removed.

Returns:

if the listener was found and succesfully removed or not.

Throws:

NullPointerException - if listener was null.

Since:

1.6

removeAllPropertyChangeListeners

public final void removeAllPropertyChangeListeners()

Remove all PropertyChangeListeners from the Property.

getChangeListeners

public final Collection<PropertyChangeListener> getChangeListeners()

Get all the PropertyChangeListeners in a Collections.unmodifiableCollection.

Returns:

a Collection of PropertyChangeListeners.

Since:

1.6

See Also:

Collections.unmodifiableCollection(Collection)