dk.heick.properties.io

Class AbstractXMLInputStreamPropertyIO

java.lang.Object

dk.heick.properties.io.AbstractPropertyIO

dk.heick.properties.io.AbstractXMLInputStreamPropertyIO

All Implemented Interfaces:

PropertyIO, Serializable

public abstract class AbstractXMLInputStreamPropertyIO
extends AbstractPropertyIO

Abstract class for handling properties which is stored in an inputstream returning xml content.
The validate method ensure that the xml 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(Document document) throws PropertyIOException".

This is a readonly PropertyIO, so calling setValue method throws an exception.
The properties are loaded from the stream once, than the stream is closed.
So when reloading the AbstractXMLInputStreamPropertyIO, then the properties is NOT reloaded from the stream. Therefore the "getCacheTime()" is set to zero, so no automatic reload is performed.

Since:

1.3

Author:

Frederik Heick

See Also:

InputStream, Serialized Form

Constructor Summary

Constructors

Constructor and Description
AbstractXMLInputStreamPropertyIO(InputStream inputStream) Constructor, set readonly and cache to true.

Method Summary

Modifier and Type	Method and Description
long	getCacheTime() How often the typed value cache for a PropertyIO should be automatically flushed every X milliseconds.
protected InputStream	getInputStream() The inputstream the PropertyIO was constructed with.
Properties	getProperties() Gets all the name,value pair in a Properties class instance.
String	getSource() A detailed description of the source of the property data.
protected abstract Properties	loadXml(Document document) 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.
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.AbstractPropertyIO

backup, 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

Methods inherited from interface dk.heick.properties.PropertyIO

getName

Constructor Detail

AbstractXMLInputStreamPropertyIO

public AbstractXMLInputStreamPropertyIO(InputStream inputStream)

Constructor, set readonly and cache to true.

Parameters:

inputStream - the input stream.

Method Detail

getInputStream

protected final InputStream getInputStream()

The inputstream the PropertyIO was constructed with.

Returns:

inputStream

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.

validate

public void validate()
              throws PropertyIOException

Description copied from interface: PropertyIO

Validates the PropertyIO.

Throws:

PropertyIOException

loadXml

protected abstract Properties loadXml(Document document)
                               throws PropertyIOException

Loads the properties from the XML file.

Parameters:

document - the DOM structure.

Returns:

a Properties instance with the XML document properties.

Throws:

PropertyIOException - if any failure loading the properties.

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

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

getSource

public String getSource()

Description copied from interface: PropertyIO

A detailed description of the source of the property data.

Returns:

a data source description.

getCacheTime

public final long getCacheTime()

Description copied from class: AbstractPropertyIO

How often the typed value cache for a PropertyIO should be automatically flushed every X milliseconds.

Specified by:

getCacheTime in interface PropertyIO

Overrides:

getCacheTime in class AbstractPropertyIO

Returns:

the cacheTime for typed cached value in milliseconds. If less than or equal to zero no automatic cache flush is performed and must be done manually with reload.

See Also:

PropertyIO.reload()