dk.heick.properties.io.specialized

Class JBossSystemPropertiesPropertyIO

java.lang.Object

dk.heick.properties.io.AbstractPropertyIO

dk.heick.properties.io.AbstractFilePropertyIO

dk.heick.properties.io.AbstractXMLFilePropertyIO

dk.heick.properties.io.specialized.JBossSystemPropertiesPropertyIO

All Implemented Interfaces:

PropertyIO, Serializable

public class JBossSystemPropertiesPropertyIO
extends AbstractXMLFilePropertyIO

Loads the properties from a XML file from an Jboss xml file.
The XML must in some point look like this:

                <system-properties>
                        <property name="n1" value="v1"/>
                        <property name="n2" value="v2"/>
                        <property name="nN" value="vN"/>
                </system-properties>
 

Since:

1.3

Author:

Frederik Heick

See Also:

Serialized Form

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
String	backup() Returns a string containing all the properties [name=value] in the PropertyIO seperated by a line feed [
protected Properties	loadXml(File file) Loads the properties from the XML file.
protected void	saveXml(Properties properties, File file) Saving the properties to the XML file, if that is possible.

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

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

JBossSystemPropertiesPropertyIO

public JBossSystemPropertiesPropertyIO(File file)

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

JBossSystemPropertiesPropertyIO

public JBossSystemPropertiesPropertyIO(File file,
                                       boolean readonly)

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

JBossSystemPropertiesPropertyIO

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

Returns a JBossSystemPropertiesPropertyIO with loads properties from the file.

Parameters:

file -

readonly - is the JBossSystemPropertiesPropertyIO to be read only.

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

Method Detail

loadXml

protected Properties loadXml(File file)
                      throws PropertyIOException

Description copied from class: AbstractXMLFilePropertyIO

Loads the properties from the XML file.

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

Description copied from class: AbstractXMLFilePropertyIO

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

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.

backup

public String backup()

Description copied from interface: PropertyIO

Returns a string containing all the properties [name=value] in the PropertyIO seperated by a line feed [

\n

].

Specified by:

backup in interface PropertyIO

Overrides:

backup in class AbstractPropertyIO

Returns:

a back string with all the properties.