dk.heick.properties.io

Class AbstractFilePropertyIO

java.lang.Object

dk.heick.properties.io.AbstractPropertyIO

dk.heick.properties.io.AbstractFilePropertyIO

All Implemented Interfaces:

PropertyIO, Serializable

Direct Known Subclasses:

AbstractXMLFilePropertyIO, FilePropertyIO

public abstract class AbstractFilePropertyIO
extends AbstractPropertyIO

Abstract PropertyIO for handling file properties.

Since:

2.0

Author:

Frederik Heick

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AbstractFilePropertyIO(File file, boolean readonly, boolean cached) Constructor.

Method Summary

Modifier and Type	Method and Description
File	getFile() The file the AbstractFilePropertyIO reads and writes to.
String	getName() A short descriptive name of the Property IO.
String	getSource() A detailed description of the source of the property data.
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, reload, setCacheTime, storeTypedValue, updateLastLoaded, updateLastSaved, validateWritable

Methods inherited from class java.lang.Object

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

Methods inherited from interface dk.heick.properties.PropertyIO

getProperties, setValue

Constructor Detail

AbstractFilePropertyIO

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

Constructor.

Parameters:

readonly - shall the AbstractPropertyIO be read only.

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

Method Detail

getFile

public final File getFile()

The file the AbstractFilePropertyIO reads and writes to.

Returns:

the file.

getName

public final 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 final String getSource()

Description copied from interface: PropertyIO

A detailed description of the source of the property data.

Returns:

a data source description.

validate

public void validate()
              throws PropertyIOException

Description copied from interface: PropertyIO

Validates the PropertyIO.

Throws:

PropertyIOException