dk.heick.properties.io

Class AbstractXMLFilePropertyIO

java.lang.Object

dk.heick.properties.io.AbstractPropertyIO

dk.heick.properties.io.AbstractFilePropertyIO

dk.heick.properties.io.AbstractXMLFilePropertyIO

All Implemented Interfaces:

PropertyIO, Serializable

Direct Known Subclasses:

JBossSystemPropertiesPropertyIO, XMLParsedFilePropertyIO

public abstract class AbstractXMLFilePropertyIO
extends AbstractFilePropertyIO

Abstract class for handling properties which is stored in xml files.
The validate method ensure that the file is a wellformed XML file. If you need further validate implemented that in extending classes.
In the class which extends this class you need to:

• Implement the different constructor, which shall be available.
• Implement method "Properties loadXml(File file) throws PropertyIOException".
• Implement method "saveXml(Properties properties,File file) throws PropertyIOException", make it empty if not needed, since AbstractXMLFilePropertyIO handles readonly situation.

Since:

1.9

Author:

Frederik Heick

See Also:

File, Serialized Form

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
Properties	getProperties() Gets all the name,value pair in a Properties class instance.
protected abstract Properties	loadXml(File file) Loads the properties from the XML file.
void	reload() Reloads the name,value pairs for the PropertyIO, or forces the values to reload when read next time.
protected abstract void	saveXml(Properties properties, File file) Saving the properties to the XML file, if that is possible.
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.AbstractFilePropertyIO

getFile, getName, getSource

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

AbstractXMLFilePropertyIO

public AbstractXMLFilePropertyIO(File file)

Returns a AbstractXMLFilePropertyIO 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.

AbstractXMLFilePropertyIO

public AbstractXMLFilePropertyIO(File file,
                                 boolean readonly)

Returns a AbstractXMLFilePropertyIO 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.

AbstractXMLFilePropertyIO

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

Returns a AbstractXMLFilePropertyIO with loads properties from the file.

Parameters:

file -

readonly - is the AbstractXMLFilePropertyIO to be read only.

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

Method Detail

reload

public final 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 final void validate()
                    throws PropertyIOException

Description copied from interface: PropertyIO

Validates the PropertyIO.

Specified by:

validate in interface PropertyIO

Overrides:

validate in class AbstractFilePropertyIO

Throws:

PropertyIOException

getProperties

public final 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

setValue

public final 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.

loadXml

protected abstract Properties loadXml(File file)
                               throws PropertyIOException

Loads the properties from the XML file.

Parameters:

file - the XML file

Returns:

a Properties instance with the XML file properties.

Throws:

PropertyIOException - if any failure loading the properties.

See Also:

XMLUtils.loadXmlFromFile(File)

saveXml

protected abstract void saveXml(Properties properties,
                                File file)
                         throws PropertyIOException

Saving the properties to the XML file, if that is possible.

Parameters:

properties - the Properties to be saved.

file - the file to save to.

Throws:

PropertyIOException - if either problems saving, or saving is not possible.