dk.heick.properties.io

Class ResourceBundlePropertyIO

java.lang.Object

dk.heick.properties.io.AbstractPropertyIO

dk.heick.properties.io.ResourceBundlePropertyIO

All Implemented Interfaces:

PropertyIO, Serializable

public class ResourceBundlePropertyIO
extends AbstractPropertyIO

Loads the properties via a ResourceBundle.getBundle method.
Using the implementation suggested in http://www.javaworld.com/article/2077352/java-se/smartly-load-your-properties.html.
Convertion rules for bundleName is:

• If the resource starts with '/' it is removed.
• All '/' is replaced by '.'.
• A message is logged if any alterations of the resourceName is performed.
• "."-separated names; all names are absolute; .properties suffix is implied.

This is a split from ResourceFilePropertyIO, which is now is deprecated.

Since:

2.0

Author:

Frederik Heick

See Also:

ResourceBundle.getBundle(String), ResourceBundle.getBundle(String, Locale), Serialized Form

Constructor Summary

Constructors

Constructor and Description
ResourceBundlePropertyIO(String bundleName) Constructor, using the default locale.
ResourceBundlePropertyIO(String bundleName, Locale locale) Convertion rules for bundleName is: If the resource starts with '/' it is removed. All '/' is replaced by '.'. A message is logged if any alterations of the resourceName is performed.

Method Summary

Modifier and Type	Method and Description
String	getBundleName() Gets the bundle name
Locale	getLocale() Gets the locale.
String	getName() A short descriptive name of the Property IO.
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.
void	setValue(String propertyName, String value) Sets the name,value as String in the IO.
void	validate() Fails validatation if: Bundle name is null. Bundle name is empty. Unable to load properties.

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

backup, getCacheTime, getLastLoaded, getLastSaved, getLogger, getTypedProperties, getTypedValue, getValue, isCached, isReadonly, logPerformanceGetProperties, logPerformanceSetValue, reload, 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

ResourceBundlePropertyIO

public ResourceBundlePropertyIO(String bundleName,
                                Locale locale)

Convertion rules for bundleName is:

• If the resource starts with '/' it is removed.
• All '/' is replaced by '.'.
• A message is logged if any alterations of the resourceName is performed.

Parameters:

bundleName - the name of the bundle.

locale - the locale instance, if null than default is used.

See Also:

Locale.getDefault()

ResourceBundlePropertyIO

public ResourceBundlePropertyIO(String bundleName)

Constructor, using the default locale.

Parameters:

bundleName - the bundle name

See Also:

Locale.getDefault()

Method Detail

getBundleName

public String getBundleName()

Gets the bundle name

Returns:

the bundleName

getLocale

public Locale getLocale()

Gets the locale.

Returns:

the locale

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 validatation if:

• Bundle name is null.
• Bundle name is empty.
• Unable to load properties.

Throws:

PropertyIOException

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