usn.i18n.nobundle

Class I18nItemInContext<TContext>

java.lang.Object

usn.i18n.nobundle.I18nItem

usn.i18n.nobundle.I18nItemInContext<TContext>

Type Parameters:

TContext - the same class as TContext for I18nHandlerInContext subclass being used

Direct Known Subclasses:

I18nItemInContext0, I18nItemInContext1, I18nItemInContext2, I18nItemInContext3, I18nItemInContextAny

public class I18nItemInContext<TContext>
extends I18nItem

The intermediate internationalized message storage and formatting class in the hierarchy to implement an approach when user preferences may be retrieved from an arbitrary generic TContext instance; not intended to be used or subclassed by applications directly.

Version:

2013-06-17

See package info for a usage example.

Author:

Sergey Ushakov, s-n-ushakov@yandex.ru

Field Summary

Fields inherited from class usn.i18n.nobundle.I18nItem

messages

Constructor Summary

Constructors

Constructor and Description
I18nItemInContext(LocalizedMessage... data) The public constructor.

Method Summary

Methods

Modifier and Type	Method and Description
String	getBestLanguage(TContext contextData) Similar to #getBestLocaleTag(TContext), but returns just the language field for the locale found.
protected LocalizedMessage	getBestLocaleAndMessage(TContext contextData) A utility method to find both the best locale suitable for given user for given I18nItemInContext instance, and the appropriate message, all represented as a LocalizedMessage instance.
String	getBestLocaleTag(TContext contextData) Find the best match, exact or approximate, among locales available for this item, for current user.
protected MessageFormat	obtainMessageFormat(TContext contextData) The method to obtain a localized MessageFormat instance to be used by subclasses that take message formatting arguments.

Methods inherited from class usn.i18n.nobundle.I18nItem

getBestLanguage, getBestLocaleAndMessage, getBestLocaleTag, obtainMessageFormat

Methods inherited from class java.lang.Object

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

Constructor Detail

I18nItemInContext

public I18nItemInContext(LocalizedMessage... data)

The public constructor.

Parameters:

data - a varargs array of translations for a message to various locales

Method Detail

getBestLocaleTag

public String getBestLocaleTag(TContext contextData)
                        throws NoSuchElementException

Find the best match, exact or approximate, among locales available for this item, for current user. Tries to find exact match for user preferences first, then approximate match for language part of user preferences only, then for application default locale, then for any English flavor, and finally tries to return just anything available. In case of several locales available for one language in this item, and only language being considered, the last locale supplied upon item construction wins. The method is exposed as public for cases when an application needs just information about best appropriate locale.

Parameters:

contextData - an instance of context-specific data to retrieve user preferences from

Returns:

the best match among available locales, represented by its locale language tag

Throws:

NoSuchElementException - should this instance happen to be empty

getBestLanguage

public String getBestLanguage(TContext contextData)
                       throws NoSuchElementException

Similar to #getBestLocaleTag(TContext), but returns just the language field for the locale found. The method is not used internally and is exposed as public for cases when an application needs just information about best appropriate language.

Parameters:

contextData - an instance of context-specific data to retrieve user preferences from

Returns:

the language field for the best match among available locales

Throws:

NoSuchElementException - should this instance happen to be empty

getBestLocaleAndMessage

protected LocalizedMessage getBestLocaleAndMessage(TContext contextData)

A utility method to find both the best locale suitable for given user for given I18nItemInContext instance, and the appropriate message, all represented as a LocalizedMessage instance.

Parameters:

contextData - an instance of context-specific data to retrieve user preferences from

Returns:

a new LocalizedMessage instance for the best locale guess

obtainMessageFormat

protected MessageFormat obtainMessageFormat(TContext contextData)

The method to obtain a localized MessageFormat instance to be used by subclasses that take message formatting arguments.

Parameters:

contextData - an instance of context-specific data to retrieve user preferences from

Returns:

a localized MessageFormat instance