dk.heick.properties.io

Class XMLParsedFilePropertyIO

java.lang.Object

dk.heick.properties.io.AbstractPropertyIO

dk.heick.properties.io.AbstractFilePropertyIO

dk.heick.properties.io.AbstractXMLFilePropertyIO

dk.heick.properties.io.XMLParsedFilePropertyIO

All Implemented Interfaces:

PropertyIO, Serializable

public class XMLParsedFilePropertyIO
extends AbstractXMLFilePropertyIO

Parses a XML file to Properties using an instance of XMLPropertiesParser

Since:

1.9

Author:

Frederik Heick

See Also:

XMLPropertiesParser, Serialized Form

Constructor Summary

Constructors

Constructor and Description
XMLParsedFilePropertyIO(File file, XMLPropertiesParser parser) Constructor, where readonly is false and cache is true.
XMLParsedFilePropertyIO(File file, XMLPropertiesParser parser, boolean readonly) Constructor, where cache is true.
XMLParsedFilePropertyIO(File file, XMLPropertiesParser parser, boolean readonly, boolean cached) Constructor.

Method Summary

Modifier and Type	Method and Description
XMLPropertiesParser	getParser() Gets the XMLPropertiesParser
protected Properties	loadXml(File file) Loads the XML file properties usung the XMLPropertiesParser
protected void	saveXml(Properties properties, File file) Updates the XML file properties and saves the file.

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

getProperties, reload, setValue, validate

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

XMLParsedFilePropertyIO

public XMLParsedFilePropertyIO(File file,
                               XMLPropertiesParser parser)
                        throws NullPointerException

Constructor, where readonly is false and cache is true.

Parameters:

file - the xml file.

parser - the instance of XMLPropertiesParser.

Throws:

NullPointerException - if either file or parser is null.

XMLParsedFilePropertyIO

public XMLParsedFilePropertyIO(File file,
                               XMLPropertiesParser parser,
                               boolean readonly)
                        throws NullPointerException

Constructor, where cache is true.

Parameters:

file - the xml file.

parser - the instance of XMLPropertiesParser.

readonly - if the properties in this instance is readonly.

Throws:

NullPointerException - if either file or parser is null.

XMLParsedFilePropertyIO

public XMLParsedFilePropertyIO(File file,
                               XMLPropertiesParser parser,
                               boolean readonly,
                               boolean cached)
                        throws NullPointerException

Constructor.

Parameters:

file - the xml file.

parser - the instance of XMLPropertiesParser.

readonly - if the properties in this instance is readonly.

cached - if the typed converted values is stored in a cache.

Throws:

NullPointerException - if either file or parser is null.

Method Detail

getParser

public XMLPropertiesParser getParser()

Gets the XMLPropertiesParser

Returns:

the parser the XML parser

loadXml

protected Properties loadXml(File file)
                      throws PropertyIOException

Loads the XML file properties usung the XMLPropertiesParser

Specified by:

loadXml in class AbstractXMLFilePropertyIO

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 final void saveXml(Properties properties,
                             File file)
                      throws PropertyIOException

Updates the XML file properties and saves the file.

Specified by:

saveXml in class AbstractXMLFilePropertyIO

Parameters:

properties - the Properties to be saved.

file - the file to save to.

Throws:

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