dk.heick.properties.io

Class ResourceFilePropertyIO

java.lang.Object

dk.heick.properties.io.AbstractPropertyIO

dk.heick.properties.io.ResourceFilePropertyIO

All Implemented Interfaces:

PropertyIO, Serializable

Deprecated.

please see ResourceStreamPropertyIO or ResourceBundlePropertyIO, will be DELETED in next version.

public class ResourceFilePropertyIO
extends AbstractPropertyIO

Loads the property file from the classLoader.getResourceAsStream().
This PropertyIO is always read only.

Since:

1.0

Author:

Frederik Heick

See Also:

ResourceStreamPropertyIO, ResourceBundlePropertyIO, Serialized Form

Constructor Summary

Constructors

Constructor and Description
ResourceFilePropertyIO(Class<?> clazz) Deprecated. Constructor with a classname as the resource name.
ResourceFilePropertyIO(Class<?> clazz, boolean useCache) Deprecated. Constructor with a classname as the resource name.
ResourceFilePropertyIO(String resourceName) Deprecated. Constructor with a path and name of the resource.
ResourceFilePropertyIO(String resourceName, boolean cached) Deprecated. The constructor for ResourceFilePropertyIO.

Method Summary

Modifier and Type	Method and Description
String	getName() Deprecated. A short descriptive name of the Property IO.
Properties	getProperties() Deprecated. A convenience overload of that uses the current thread's context classloader.
protected Properties	getProperties(String resourceName) Deprecated. Loads a resource using Thread.currentThread().getContextClassLoader().getResourceAsStream(name).
String	getResourceName() Deprecated. The name of the resource.
String	getSource() Deprecated. A detailed description of the source of the property data.
void	reload() Deprecated. Reloads the name,value pairs for the PropertyIO, or forces the values to reload when read next time.
void	setValue(String propertyName, String value) Deprecated. Sets the name,value as String in the IO.
void	validate() Deprecated. Validates the PropertyIO.

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

ResourceFilePropertyIO

public ResourceFilePropertyIO(String resourceName)

Deprecated.

Constructor with a path and name of the resource. If the name do not end with ".properties" this is added to the name.

Parameters:

resourceName - the resource name.

See Also:

ResourceFilePropertyIO(String, boolean)

ResourceFilePropertyIO

public ResourceFilePropertyIO(Class<?> clazz)

Deprecated.

Constructor with a classname as the resource name. If the name of the class ends with "Properties" this is removed and ".properties" is added. If the name of the class do not ends with "Properties", ".properties" is added.
Examples:

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

Parameters:

clazz - the class to use for loading

Throws:

NullPointerException - if clazz is null.

ResourceFilePropertyIO

public ResourceFilePropertyIO(Class<?> clazz,
                              boolean useCache)

Deprecated.

Constructor with a classname as the resource name. If the name of the class ends with "Properties" this is removed and ".properties" is added. If the name of the class do not ends with "Properties", ".properties" is added.
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

useCache - if the type converted object shall be stored in cached, avoiding repeatly conversions.

Throws:

NullPointerException - if clazz is null.

ResourceFilePropertyIO

public ResourceFilePropertyIO(String resourceName,
                              boolean cached)

Deprecated.

The constructor for ResourceFilePropertyIO.
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'
• String 'ImportConfig' converted to 'ImportConfig.properties'
• String 'ImportConfig.properties' converted to 'ImportConfig.properties'
• String 'WEB-INF/config/ImportConfig.properties' converted to 'WEB-INF/config/ImportConfig.properties'

Parameters:

resourceName -

cached - if the type converted object shall be stored in cached, avoiding repeatly conversions.

Method Detail

getResourceName

public String getResourceName()

Deprecated.

The name of the resource.

Returns:

the resource name.

getName

public String getName()

Deprecated.

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()

Deprecated.

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

Deprecated.

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

Deprecated.

Description copied from interface: PropertyIO

Validates the PropertyIO.

Throws:

PropertyIOException

reload

public void reload()

Deprecated.

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()

Deprecated.

A convenience overload of that uses the current thread's context classloader.

Returns:

the Properties available for the IO.

See Also:

Properties

getProperties

protected Properties getProperties(String resourceName)
                            throws PropertyIOException

Deprecated.

Loads a resource using Thread.currentThread().getContextClassLoader().getResourceAsStream(name).

Parameters:

resourceName - the name of the resource.

Returns:

Properties loaded with the resource.

Throws:

PropertyIOException