io.rincl

Class AbstractResourceI18nConcern

java.lang.Object

io.rincl.AbstractResourceI18nConcern

All Implemented Interfaces:

io.csar.Concern, ResourceI18nConcern

public abstract class AbstractResourceI18nConcern
extends Object
implements ResourceI18nConcern

Abstract base class to facilitate implementing the concern for internationalization of resources.

This class provides an implementation of getLocale(Locale.Category) and ResourceI18nConcern.setLocale(Locale).

Author:

Garret Wilson

Constructor Summary

Constructors

Constructor and Description
AbstractResourceI18nConcern() Default constructor.

Method Summary

Modifier and Type	Method and Description
Locale	getLocale(Locale.Category category) Retrieves the configured locale for the given category.
protected Optional<Resources>	getParentResources(Class<?> contextClass) Retrieves parent resources for the given context.
void	setLocale(Locale.Category category, Locale locale) Configures the locale for this concern instance for the given locale category.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.rincl.ResourceI18nConcern

getConcernType, getResources, setLocale

Constructor Detail

AbstractResourceI18nConcern

public AbstractResourceI18nConcern()

Default constructor.

Method Detail

getLocale

public Locale getLocale(@Nonnull
                        Locale.Category category)

Description copied from interface: ResourceI18nConcern

Retrieves the configured locale for the given category.

If no category has been configured for this concern instance, this method delegates to Locale.getDefault(Locale.Category).

Specified by:

getLocale in interface ResourceI18nConcern

Parameters:

category - The category of locale to return.

Returns:

The the configured locale for the given category.

See Also:

ResourceI18nConcern.setLocale(Locale.Category, Locale), Locale.getDefault(Locale.Category)

setLocale

public void setLocale(@Nonnull
                      Locale.Category category,
                      @Nonnull
                      Locale locale)

Configures the locale for this concern instance for the given locale category. Future calls to getLocale(Locale.Category) will return the value set here.

This method does not modify the default JVM locale.

Specified by:

setLocale in interface ResourceI18nConcern

Parameters:

category - The category for which the locale should be set..

locale - The new locale value.

Throws:

NullPointerException - if the given category and/or new locale is null.

See Also:

getLocale(Locale.Category)

getParentResources

protected Optional<Resources> getParentResources(@Nonnull
                                                 Class<?> contextClass)
                                          throws ResourceConfigurationException

Retrieves parent resources for the given context.

This method should be used by subclass ResourceI18nConcern.getResources(Class) implementations to determine the parent resources to use.

The default implementation returns an empty optional.

Parameters:

contextClass - The context with which these resources are related; usually the class of the object requesting the resource.

Returns:

The resources for fallback resource resolution.

Throws:

NullPointerException - if the given context class is null.

ResourceConfigurationException - if there is a configuration error.