io.rincl

Class Rincl

java.lang.Object

io.rincl.Rincl

public class Rincl
extends Object

The Resource I18n Concern Library (Rincl) facilitates internationalization by providing access to localization Resources via Csar.

Rincl uses the Csar ConcernProvider mechanism, so that an application can have access to a globally configured default Rincl implementation simply by including that implementation's dependency. For example merely including the dependency io.rincl:rincl-resourcebundle:x.x.x will automatically provide resources from resource bundle property file lookup. Classes desiring resource access may then then implement Rincled for simplified retrieval of Resources.

More complex configuration may be done by manual configuration using using setDefaultResourceI18nConcern(ResourceI18nConcern) with the concern of choice, as in the following example:

 
 Rincl.setDefaultResourceI18nConcern(new MyResourceI18nConcern());
 
 

Author:

Garret Wilson

See Also:

Csar

Constructor Summary

Constructors

Constructor and Description
Rincl()

Method Summary

Modifier and Type	Method and Description
static Optional<ResourceI18nConcern>	getDefaultResourceI18nConcern() Returns the default resource i18n concern.
static Locale	getLocale(Locale.Category category) Retrieves the configured locale for the given category in the current context.
static ResourceI18nConcern	getResourceI18nConcern() Returns the configured resource i18n concern for the current context.
static Resources	getResources(Class<?> contextClass) Retrieves resources for the current context for the given context class.
static Optional<ResourceI18nConcern>	setDefaultResourceI18nConcern(ResourceI18nConcern resourceI18nConcern) Sets the default resource i18n concern.
static void	setLocale(Locale.Category category, Locale locale) Configures the locale for the current context for the given locale category.
static void	setLocale(Locale locale) Configures the locale for the current context for all locale categories.

Methods inherited from class java.lang.Object

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

Constructor Detail

Rincl

public Rincl()

Method Detail

getDefaultResourceI18nConcern

public static Optional<ResourceI18nConcern> getDefaultResourceI18nConcern()

Returns the default resource i18n concern.

Returns:

The default resource i18n concern.

See Also:

Csar.getDefaultConcern(Class)

setDefaultResourceI18nConcern

public static Optional<ResourceI18nConcern> setDefaultResourceI18nConcern(@Nonnull
                                                                          ResourceI18nConcern resourceI18nConcern)

Sets the default resource i18n concern.

Parameters:

resourceI18nConcern - The default resource i18n concern to set.

Returns:

The previous concern, or null if there was no previous concern.

Throws:

NullPointerException - if the given concern is null.

See Also:

Csar.registerDefaultConcern(Class, Concern)

getResourceI18nConcern

@Nonnull
public static ResourceI18nConcern getResourceI18nConcern()

Returns the configured resource i18n concern for the current context.

If no resource i18n concern is registered for the current context, and no default resource i18n concern concern is registered, a resource i18n concern will be return that provides empty resources.

Returns:

The configured resource i18n concern for the current context.

Throws:

io.csar.ConcernNotFoundException - if no resource i18n concern is configured.

See Also:

Csar.getConcern(Class), EmptyResourceI18nConcern.INSTANCE

getResources

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

Retrieves resources for the current context for the given context class.

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

This is a convenience method that requests resources from the current context resource i18n concern.

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 in the current context.

Throws:

NullPointerException - if the given context class is null.

ResourceConfigurationException - if there is a configuration error.

See Also:

getResourceI18nConcern(), ResourceI18nConcern.getResources(Class)

getLocale

public static Locale getLocale(@Nonnull
                               Locale.Category category)

Retrieves the configured locale for the given category in the current context.

If no category has been configured for the concern context, or there is no configured ResourceI18nConcern, this method delegates to Locale.getDefault(Locale.Category).

This method may safely be used without configuring Rincl.

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:

getResourceI18nConcern(), ResourceI18nConcern.getLocale(Locale.Category), Locale.getDefault(Locale.Category)

setLocale

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

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

If the current context ResourceI18nConcern is the default, or there is no configured ResourceI18nConcern, this method updates the JVM default locale for the category using Locale.setDefault(Locale.Category, Locale).

This method may safely be used without configuring Rincl.

Parameters:

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

locale - The new locale value.

Throws:

SecurityException - if a security manager exists and its SecurityManager.checkPermission(java.security.Permission) method doesn't allow the operation.

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

See Also:

SecurityManager.checkPermission(java.security.Permission), PropertyPermission, Locale.setDefault(Locale.Category, Locale), getLocale(Locale.Category)

setLocale

public static void setLocale(@Nonnull
                             Locale locale)

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

If the current context ResourceI18nConcern is the default, or there is no configured ResourceI18nConcern, this method updates the JVM default locale using Locale.setDefault(Locale).

This method may safely be used without configuring Rincl.

Parameters:

locale - The new locale value.

Throws:

SecurityException - if a security manager exists and its SecurityManager.checkPermission(java.security.Permission) method doesn't allow the operation.

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

See Also:

SecurityManager.checkPermission(java.security.Permission), PropertyPermission, Locale.setDefault(Locale), getLocale(Locale.Category)