dk.heick.properties.io

Class MemoryPropertyIO

java.lang.Object

dk.heick.properties.io.AbstractPropertyIO

dk.heick.properties.io.MemoryPropertyIO

All Implemented Interfaces:

PropertyIO, Serializable

public class MemoryPropertyIO
extends AbstractPropertyIO

A PropertyIO which holds it properties in memory.

Since:

1.0

Author:

Frederik Heick

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
MemoryPropertyIO(Properties properties) Returns a MemoryPropertyIO which is initialized with a Properties instance.
MemoryPropertyIO(Properties properties, boolean readonly) Returns a MemoryPropertyIO which is initialized with a Properties instance.
MemoryPropertyIO(PropertyIO io) Returns a MemoryPropertyIO which is initialized with a Properties instance from another PropertyIO using the method PropertyIO.getProperties().

Method Summary

Modifier and Type	Method and Description
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.
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

backup, getCacheTime, getLastLoaded, getLastSaved, getLogger, getTypedProperties, getTypedValue, getValue, 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

MemoryPropertyIO

public MemoryPropertyIO(Properties properties)

Returns a MemoryPropertyIO which is initialized with a Properties instance. Readonly is false and cached is true.

Parameters:

properties - the properties instance.

MemoryPropertyIO

public MemoryPropertyIO(Properties properties,
                        boolean readonly)

Returns a MemoryPropertyIO which is initialized with a Properties instance. Cached is true.

Parameters:

properties - the properties instance.

readonly - shall the MemoryPropertyIO be read only.

MemoryPropertyIO

public MemoryPropertyIO(PropertyIO io)

Returns a MemoryPropertyIO which is initialized with a Properties instance from another PropertyIO using the method PropertyIO.getProperties().

Parameters:

io - the PropertyIO instance.

See Also:

PropertyIO.getProperties()

Method Detail

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

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.

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.

validate

public void validate()
              throws PropertyIOException

Description copied from interface: PropertyIO

Validates the PropertyIO.

Throws:

PropertyIOException

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