PropertyLoader (uk.co.strangeskies)

All Known Implementing Classes:

PropertyLoaderService
```
public interface PropertyLoader
```
This interface represents a simple but powerful system for internationalization. Instances of this class provide automatic implementations of sub-interfaces of Properties according to a Locale setting, which delegate method invocations to be fetched from resource bundles.
A property accessor interface is an interface to provide an API over static properties and localized text and data. Users should not implement this class themselves, instead they should define sub-interfaces, allowing implementations to be automatically provided by PropertyLoader.
User defined methods on a property accessor interface may return values of any type, so long as a PropertyValueProvider is given to the property loader which supports that type. Special handling is performed for the Localized type, and for methods returning nested accessor classes.
A key is generated for each method based on the class and method name. The key is generated according to the PropertyConfiguration used to load the Properties instance.
Default and static methods will be invoked directly.
A Properties instance is Observable over changes to its locale, with the instance itself being passed as the message to observers.
For an example of how to use this interface, users may wish to take a look at the PropertyLoaderProperties interface.

Field Summary

Fields
Modifier and Type Field and Description

static PropertyLoader DEFAULT_PROPERTY_LOADER
As returned by getDefaultPropertyLoader().

Fields
Modifier and Type	Field and Description
`static PropertyLoader`	`DEFAULT_PROPERTY_LOADER` As returned by `getDefaultPropertyLoader()`.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`static <T> T`	`getDefaultProperties(java.lang.Class<T> accessor)` Generate an implementing instance of the given accessor interface class, according to the rules described by `Properties`.
`static <T> T`	`getDefaultProperties(PropertyAccessorConfiguration<T> accessorConfiguration)` Get a `property implementation` from the `default loader`.
`static PropertyLoader`	`getDefaultPropertyLoader()` Get a simple `PropertyLoader` implementation over the `system locale`.
`java.util.Locale`	`getLocale()`
`PropertyLoaderProperties`	`getProperties()`
`default <T> T`	`getProperties(java.lang.Class<T> accessor)` Generate an implementing instance of the given accessor interface class, according to the rules described by `Properties`.
`<T> T`	`getProperties(PropertyAccessorConfiguration<T> accessorConfiguration)` Generate an implementing instance of the given accessor interface class, according to the rules described by `Properties`.
`static PropertyLoader`	`getPropertyLoader(LocaleProvider provider)` Get a simple `PropertyLoader` implementation over the given locale provider.
`static PropertyLoader`	`getPropertyLoader(LocaleProvider provider, Log log)` Get a simple `PropertyLoader` implementation over the given locale provider.
`java.util.Set<java.lang.Class<? extends PropertyResourceStrategy<?>>>`	`getResourceStrategies()`
`<T extends PropertyResourceStrategy<T>> T`	`getResourceStrategy(java.lang.Class<T> strategy)`
`java.util.Optional<PropertyValueProvider<?>>`	`getValueProvider(java.lang.reflect.AnnotatedType type)`
`java.util.List<PropertyValueProviderFactory>`	`getValueProviders()`
`ObservableValue<java.util.Locale>`	`locale()`
`<T extends PropertyResourceStrategy<T>> boolean`	`registerResourceStrategy(T strategy)`
`boolean`	`registerValueProvider(PropertyValueProviderFactory propertyProvider)`
`<T extends PropertyResourceStrategy<T>> void`	`setDefaultResourceStrategy(T strategy)`
`<T extends PropertyResourceStrategy<T>> boolean`	`unregisterResourceStrategy(T strategy)`
`boolean`	`unregisterValueProvider(PropertyValueProviderFactory propertyProvider)`

- Field Detail
  - DEFAULT_PROPERTY_LOADER
```
static final PropertyLoader DEFAULT_PROPERTY_LOADER
```
    As returned by getDefaultPropertyLoader().
- Method Detail
  - getLocale
```
java.util.Locale getLocale()
```
    Returns:
    
    the current locale of all localized texts implemented by this PropertyLoader
  - locale
```
ObservableValue<java.util.Locale> locale()
```
    Returns:
    
    an observable over changes to the locale
  - registerValueProvider
```
boolean registerValueProvider(PropertyValueProviderFactory propertyProvider)
```
    Parameters:
    
    propertyProvider - a provider for a type of property
    
    Returns:
    
    true if the provider was registered, false otherwise
  - unregisterValueProvider
```
boolean unregisterValueProvider(PropertyValueProviderFactory propertyProvider)
```
    Parameters:
    
    propertyProvider - a provider for a type of property
    
    Returns:
    
    true if the provider was unregistered, false otherwise
  - getValueProviders
```
java.util.List<PropertyValueProviderFactory> getValueProviders()
```
    Returns:
    
    all available property providers
  - getValueProvider
```
java.util.Optional<PropertyValueProvider<?>> getValueProvider(java.lang.reflect.AnnotatedType type)
```
    Parameters:
    
    type - the exact annotated type to provide
    
    Returns:
    
    a property value provider aggregating all available factories over the given type
  - registerResourceStrategy
```
<T extends PropertyResourceStrategy<T>> boolean registerResourceStrategy(T strategy)
```
    Parameters:
    
    strategy - the strategy to register
    
    Returns:
    
    true if the strategy was registered, false otherwise
  - unregisterResourceStrategy
```
<T extends PropertyResourceStrategy<T>> boolean unregisterResourceStrategy(T strategy)
```
    Parameters:
    
    strategy - the strategy to unregister
    
    Returns:
    
    true if the strategy was unregistered, false otherwise
  - getResourceStrategies
```
java.util.Set<java.lang.Class<? extends PropertyResourceStrategy<?>>> getResourceStrategies()
```
  - getResourceStrategy
```
<T extends PropertyResourceStrategy<T>> T getResourceStrategy(java.lang.Class<T> strategy)
```
  - setDefaultResourceStrategy
```
<T extends PropertyResourceStrategy<T>> void setDefaultResourceStrategy(T strategy)
```
  - getProperties
```
<T> T getProperties(PropertyAccessorConfiguration<T> accessorConfiguration)
```
    Generate an implementing instance of the given accessor interface class, according to the rules described by Properties.
    
    Type Parameters:
    
    T - the type of the localization text accessor interface
    
    Parameters:
    
    accessorConfiguration - configuration object for the sub-interface of Properties we wish to implement, and the default property configuration to apply
    
    Returns:
    
    an implementation of the accessor interface
  - getProperties
```
default <T> T getProperties(java.lang.Class<T> accessor)
```
    Generate an implementing instance of the given accessor interface class, according to the rules described by Properties.
    
    Type Parameters:
    
    T - the type of the localization text accessor interface
    
    Parameters:
    
    accessor - the sub-interface of Properties we wish to implement
    
    Returns:
    
    an implementation of the accessor interface
  - getProperties
```
PropertyLoaderProperties getProperties()
```
    Returns:
    
    the properties associated directly with the property loader itself
  - getDefaultPropertyLoader
```
static PropertyLoader getDefaultPropertyLoader()
```
    Get a simple PropertyLoader implementation over the system locale.
    
    Returns:
    
    a PropertyLoader for the system locale
  - getDefaultProperties
```
static <T> T getDefaultProperties(PropertyAccessorConfiguration<T> accessorConfiguration)
```
    Get a property implementation from the default loader.
    
    Type Parameters:
    
    T - the type of the localization text accessor interface
    
    Parameters:
    
    accessorConfiguration - configuration object for the sub-interface of Properties we wish to implement, and the default property configuration to apply
    
    Returns:
    
    an implementation of the accessor interface
  - getDefaultProperties
```
static <T> T getDefaultProperties(java.lang.Class<T> accessor)
```
    Generate an implementing instance of the given accessor interface class, according to the rules described by Properties.
    
    Type Parameters:
    
    T - the type of the localization text accessor interface
    
    Parameters:
    
    accessor - the sub-interface of Properties we wish to implement
    
    Returns:
    
    an implementation of the accessor interface
  - getPropertyLoader
```
static PropertyLoader getPropertyLoader(LocaleProvider provider)
```
    Get a simple PropertyLoader implementation over the given locale provider.
    
    Parameters:
    
    provider - a provider to establish a locale setting
    
    Returns:
    
    a PropertyLoader for the given locale
  - getPropertyLoader
```
static PropertyLoader getPropertyLoader(LocaleProvider provider,
                                        Log log)
```
    Get a simple PropertyLoader implementation over the given locale provider.
    
    Parameters:
    
    provider - a provider to establish a locale setting
    
    log - a log for localization information
    
    Returns:
    
    a PropertyLoader for the given locale

Interface PropertyLoader

Field Summary

Method Summary

Field Detail

DEFAULT_PROPERTY_LOADER

Method Detail

getLocale

locale

registerValueProvider

unregisterValueProvider

getValueProviders

getValueProvider

registerResourceStrategy

unregisterResourceStrategy

getResourceStrategies

getResourceStrategy

setDefaultResourceStrategy

getProperties

getProperties

getProperties

getDefaultPropertyLoader

getDefaultProperties

getDefaultProperties

getPropertyLoader

getPropertyLoader