dk.heick.properties.io

Class ResourceStreamPropertyIO

java.lang.Object

dk.heick.properties.io.AbstractPropertyIO

dk.heick.properties.io.ResourceStreamPropertyIO

All Implemented Interfaces:

PropertyIO, Serializable

public class ResourceStreamPropertyIO
extends AbstractPropertyIO

Loads the property file from the classLoader.getResourceAsStream().
Using the rules specified in http://www.javaworld.com/article/2077352/java-se/smartly-load-your-properties.html.
Convertion rules for resourceName is:

• Loading using the Thread.currentThread ().getContextClassLoader()
• If the resourceName do not end with ".properties" this is added to the resourceName.
• If the resource starts with '/' it is removed.
• All '.' is replaced by '/'.
• A message is logged if any alterations of the resourceName is performed.

This PropertyIO is always read only.

Since:

1.0

Version:

2.0

Author:

Frederik Heick

See Also:

Thread.getContextClassLoader(), Serialized Form

Constructor Summary

Constructors

Constructor and Description
ResourceStreamPropertyIO(Class<?> clazz) Constructor with a classname as the resource name.
ResourceStreamPropertyIO(String resourceName) Constructor with a path and name of the resource.

Method Summary

Modifier and Type	Method and Description
String	getName() A short descriptive name of the Property IO.
Properties	getProperties() A convenience overload of that uses the current thread's context classloader.
String	getResourceName() The name of the resource.
String	getSource() A detailed description of the source of the property data.
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() Fails validation if ResourceName is null or empty. Not able to getProperties(), it returns null.

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

ResourceStreamPropertyIO

public ResourceStreamPropertyIO(String resourceName)

Constructor with a path and name of the resource. Convertion rules for resourceName is:

• Loading using the Thread.currentThread ().getContextClassLoader()
• If the resourceName do not end with ".properties" this is added to the resourceName.
• If the resourceName starts with '/' it is removed.
• All '.' is replaced by '/'.
• A message is logged if any alterations of the resourceName is performed.

Parameters:

resourceName - the resource name.

ResourceStreamPropertyIO

public ResourceStreamPropertyIO(Class<?> clazz)

Constructor with a classname as the resource name. Convertion rules for classname is:

• If the resourceName do not end with ".properties" this is added to the resourceName.
• If the resourceName starts with '/' it is removed.
• All '.' is replaced by '/'.
• A message is logged if any alterations of the resourceName is performed.

Examples:

• Class 'org.firm.config.ImportConfig' converted to 'org/firm/config/importconfig.properties'
• Class 'org.firm.config.ImportProperties' converted to 'org/firm/config/importproperties.properties'

Parameters:

clazz - the class to use for loading

Throws:

NullPointerException - if clazz is null.

Method Detail

getResourceName

public String getResourceName()

The name of the resource.

Returns:

the resource name.

getName

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

Description copied from interface: PropertyIO

A detailed description of the source of the property data.

Returns:

a data source description.

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

Fails validation if

• ResourceName is null or empty.
• Not able to getProperties(), it returns null.

Throws:

PropertyIOException

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

getProperties

public Properties getProperties()

A convenience overload of that uses the current thread's context classloader.
ClassLoader loader = Thread.currentThread ().getContextClassLoader();

Returns:

the Properties available for the IO.

See Also:

Properties