dk.heick.properties.io

Class FilePropertyIO

java.lang.Object

dk.heick.properties.io.AbstractPropertyIO

dk.heick.properties.io.AbstractFilePropertyIO

dk.heick.properties.io.FilePropertyIO

All Implemented Interfaces:

PropertyIO, Serializable

public class FilePropertyIO
extends AbstractFilePropertyIO

Loads the properties via a File using Properties.load method.

Since:

1.0

Author:

Frederik Heick

See Also:

File, Properties, Properties.load(java.io.Reader), Serialized Form

Constructor Summary

Constructors

Constructor and Description
FilePropertyIO(File file) Returns a FilePropertyIO with loads properties from the file.
FilePropertyIO(File file, boolean readonly) Returns a FilePropertyIO with loads properties from the file.
FilePropertyIO(File file, boolean readonly, boolean cached) Returns a FilePropertyIO with loads properties from the file.

Method Summary

Modifier and Type	Method and Description
CommentedProperties	getCommentedProperties() Gets the CommentedProperties instance, whre both Properties and their comments are stored.
Properties	getProperties() Gets all the name,value pair in a Properties class instance.
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.

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

getFile, getName, getSource, validate

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

FilePropertyIO

public FilePropertyIO(File file)

Returns a FilePropertyIO with loads properties from the file.
Attributes readonly is set to false and cached is set to true.

Parameters:

file - the file to load properties from.

FilePropertyIO

public FilePropertyIO(File file,
                      boolean readonly)

Returns a FilePropertyIO with loads properties from the file. Attributes cached is set to true.

Parameters:

file - the file to load properties from.

readonly - is the FilePropertyIO to be read only.

FilePropertyIO

public FilePropertyIO(File file,
                      boolean readonly,
                      boolean cached)

Returns a FilePropertyIO with loads properties from the file.

Parameters:

file -

readonly - is the FilePropertyIO to be read only.

cached - shall the values be cached in the PropertyIO's.

Method Detail

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

getCommentedProperties

public final CommentedProperties getCommentedProperties()

Gets the CommentedProperties instance, whre both Properties and their comments are stored.

Returns:

the CommentedProperties instance.

Since:

2.0

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