uk.co.strangeskies.text.properties

Interface PropertyResource

All Known Implementing Classes:

PropertyResourceBundle

public interface PropertyResource

A resource bundle with a configurable locale

Method Summary

Modifier and Type	Method and Description
java.lang.Class<?>	getAccessor()
static <T> PropertyResource	getBundle(java.util.Locale locale, java.lang.Class<T> accessor, java.lang.String resource) Create a localizing resource bundle over the given configuration.
default java.util.Set<java.lang.String>	getKeys()
java.util.Set<java.lang.String>	getKeys(java.util.Locale locale)
PropertyResourceStrategy<?>	getStrategy()
default java.lang.String	getValue(java.lang.String key)
java.lang.String	getValue(java.lang.String key, java.util.Locale locale)

Method Detail

getKeys

default java.util.Set<java.lang.String> getKeys()

Returns:

the set of available keys according to the root locale

getKeys

java.util.Set<java.lang.String> getKeys(java.util.Locale locale)

Parameters:

locale - the locale

Returns:

the set of available keys according to the given locale

getValue

default java.lang.String getValue(java.lang.String key)

Parameters:

key - the key of the property

Returns:

the value of the property of the given key according to the root locale

getValue

java.lang.String getValue(java.lang.String key,
                          java.util.Locale locale)

Parameters:

key - the key of the property

locale - the locale

Returns:

the value of the property of the given key according to the given locale

getStrategy

PropertyResourceStrategy<?> getStrategy()

Returns:

the strategy employed to locate the resources backing this bundle

getAccessor

java.lang.Class<?> getAccessor()

Returns:

the property resource configuration

getBundle

static <T> PropertyResource getBundle(java.util.Locale locale,
                                      java.lang.Class<T> accessor,
                                      java.lang.String resource)

Create a localizing resource bundle over the given configuration. TODO The created resource bundle will behave as a delegate to a series of resource bundles , which in turn will behave according to ResourceBundle.getBundle(String, Locale, ClassLoader) with the given class loader, using the given locations as base names, and using the current locale of the PropertyResource. This locale may change, and the delegate resource bundles will be updated accordingly.

Parameters:

locale - the locale for the resource bundle

accessor - the base names of properties files to load, and the class loaders they exist in

Returns:

a resource bundle over all resources at each given location