io.rincl

Interface ResourceI18nConcern

All Superinterfaces:

io.csar.Concern

All Known Implementing Classes:

AbstractResourceI18nConcern, EmptyResourceI18nConcern

public interface ResourceI18nConcern
extends io.csar.Concern

The concern for internationalization of resources.

Once this concern is acquired, it provides access to a specific set of Resources for some context class, e.g. the class of the instance requesting resources.

Author:

Garret Wilson

See Also:

Csar

Method Summary

Modifier and Type	Method and Description
default Class<ResourceI18nConcern>	getConcernType()
Locale	getLocale(Locale.Category category) Retrieves the configured locale for the given category.
Resources	getResources(Class<?> contextClass) Retrieves resources for the given context.
void	setLocale(Locale.Category category, Locale locale) Configures the locale for this concern instance for the given locale category.
default void	setLocale(Locale locale) Configures the locale for this concern instance for all locale categories.

Method Detail

getConcernType

default Class<ResourceI18nConcern> getConcernType()

Specified by:

getConcernType in interface io.csar.Concern

getLocale

Locale getLocale(@Nonnull
                 Locale.Category category)

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

Parameters:

category - The category of locale to return.

Returns:

The the configured locale for the given category.

Throws:

NullPointerException - if the given category is null.

See Also:

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

setLocale

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.

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)

setLocale

default void setLocale(@Nonnull
                       Locale locale)

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

This is a convenience method to set all locale categories.

This method does not modify the default JVM locale.

Parameters:

locale - The new locale value.

Throws:

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

See Also:

setLocale(Locale.Category, Locale), getLocale(Locale.Category)

getResources

@Nonnull
Resources getResources(@Nonnull
                                 Class<?> contextClass)
                          throws ResourceConfigurationException

Retrieves resources for the given context.

The context class returned by Resources.getContextClass() may not necessarily be the context class provided here.

Parameters:

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

Returns:

Access to configured resources for the given context class.

Throws:

NullPointerException - if the given context class is null.

ResourceConfigurationException - if there is a configuration error.