dk.heick.properties.io

Class CompositePropertyIO

java.lang.Object

dk.heick.properties.io.AbstractPropertyIO

dk.heick.properties.io.CompositePropertyIO

All Implemented Interfaces:

PropertyIO, Serializable

public class CompositePropertyIO
extends AbstractPropertyIO

Load properties from multiple PropertyIO's. If the a property name exists in multiple files it will be loaded from the first PropertyIO where it exists.

Since:

1.0

Author:

Frederik Heick

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CompositePropertyIO(List<? extends PropertyIO> ios) Returns a CompositePropertyIO initialized with an list of PropertyIO instances.
CompositePropertyIO(PropertyIO... ios) Returns a CompositePropertyIO initialized with an array of PropertyIO instances.

Method Summary

Modifier and Type	Method and Description
String	backup() Returns a string containing all the properties [name=value] in the PropertyIO seperated by a line feed [
protected List<PropertyIO>	getIos() Gets the list of PropertyIO's.
String	getName() A short descriptive name of the Property IO.
Properties	getProperties() Gets all the name,value pair in a Properties class instance.
String	getSource() A detailed description of the source of the property data.
String	getValue(String propertyName) Gets the string value of the name.
void	reload() Reloads the name,value pairs for the PropertyIO, or forces the values to reload when read next time.
void	setValue(String propertyName, String value) Sets the name,value as String in the IO.
void	validate() Validates the PropertyIO.

Methods inherited from class dk.heick.properties.io.AbstractPropertyIO

getCacheTime, getLastLoaded, getLastSaved, getLogger, getTypedProperties, getTypedValue, isCached, isReadonly, logPerformanceGetProperties, logPerformanceSetValue, setCacheTime, storeTypedValue, updateLastLoaded, updateLastSaved, validateWritable

Methods inherited from class java.lang.Object

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

Constructor Detail

CompositePropertyIO

public CompositePropertyIO(PropertyIO... ios)

Returns a CompositePropertyIO initialized with an array of PropertyIO instances.

Parameters:

ios - an array of PropertyIO.

CompositePropertyIO

public CompositePropertyIO(List<? extends PropertyIO> ios)

Returns a CompositePropertyIO initialized with an list of PropertyIO instances.

Parameters:

ios - an list of PropertyIO.

See Also:

List

Method Detail

getIos

protected List<PropertyIO> getIos()

Gets the list of PropertyIO's.

Returns:

an Collections.unmodifiableList with the PropertyIO.

getName

public String getName()

Description copied from interface: PropertyIO

A short descriptive name of the Property IO.

Returns:

a short descriptive name of the PropertyIO class.

getSource

public String getSource()

Description copied from interface: PropertyIO

A detailed description of the source of the property data.

Returns:

a data source description.

getValue

public String getValue(String propertyName)

Description copied from interface: PropertyIO

Gets the string value of the name.
Remember to use the cached value, if it shall be used.
IMPORTANT : When reading a value from a PropertyIO, the value is pre parsed before validation. Remember to call this method in your implementation.
You can use ${name} in the value, will be passed by the StringUtils.replaceInlinedProperties(String) method, to replace ${name} where name can either be a System.getProperty(String) or System.getenv(String).

Specified by:

getValue in interface PropertyIO

Overrides:

getValue in class AbstractPropertyIO

Parameters:

propertyName - the name of the property.

Returns:

the value of the property name, if none exists null is returned.

See Also:

StringUtils.replaceInlinedProperties(String), PropertyFrameworkGlobals

setValue

public void setValue(String propertyName,
                     String value)
              throws PropertyIOException

Description copied from interface: PropertyIO

Sets the name,value as String in the IO. Many IO implementations reloads when a value is set to refresh cache.
This is recommended, but the framework will update cache items with new values.

Parameters:

propertyName - the name of the property

value - the string value of the property.

Throws:

PropertyIOException - if the IO is readonly or failed to write the value.

reload

public void reload()

Description copied from interface: PropertyIO

Reloads the name,value pairs for the PropertyIO, or forces the values to reload when read next time. Remember to both reset properties and typed value cache if used.

Specified by:

reload in interface PropertyIO

Overrides:

reload in class AbstractPropertyIO

validate

public void validate()
              throws PropertyIOException

Description copied from interface: PropertyIO

Validates the PropertyIO.

Throws:

PropertyIOException

getProperties

public Properties getProperties()

Description copied from interface: PropertyIO

Gets all the name,value pair in a Properties class instance.

Returns:

the Properties available for the IO.

See Also:

Properties

backup

public String backup()

Description copied from interface: PropertyIO

Returns a string containing all the properties [name=value] in the PropertyIO seperated by a line feed [

\n

].

Specified by:

backup in interface PropertyIO

Overrides:

backup in class AbstractPropertyIO

Returns:

a back string with all the properties.