com.google.template.soy.msgs

Class SoyMsgBundleWithFullLocale

java.lang.Object

com.google.template.soy.msgs.SoyMsgBundle

com.google.template.soy.msgs.SoyMsgBundleWithFullLocale

All Implemented Interfaces:

Iterable<SoyMsg>

public final class SoyMsgBundleWithFullLocale
extends SoyMsgBundle

Wraps SoyMsgBundle along with the original locale that was used to look it up. This helps preserve fully-qualified locales for Guice-injection into `SoyJavaFunction`s via `@LocaleString`. Fully-qualified locales with country code are required, for example, for accurate date, number, and currency localization.

Field Summary

Fields inherited from class com.google.template.soy.msgs.SoyMsgBundle

EMPTY

Method Summary

Modifier and Type	Method and Description
SoyMsgBundle	getInnerSoyMsgBundle()
com.ibm.icu.util.ULocale	getLocale() Returns the ULocale of this message bundle.
String	getLocaleString() Gets the language/locale string of this bundle of messages.
SoyMsg	getMsg(long msgId) Retrieves a message by its unique message id.
com.google.common.collect.ImmutableList<SoyMsgPart>	getMsgParts(long msgId) Returns the message parts, or an empty array if there is no such message.
int	getNumMsgs() Gets the number of messages in this bundle.
boolean	isRtl() Returns true if this is an RTL (right-to-left) locale.
Iterator<SoyMsg>	iterator() Returns an iterator over all the messages.
static SoyMsgBundle	preservingLocaleIfAllowed(SoyMsgBundle bundle, Locale locale) Returns a soy message bundle that exposes `locale` as its locale IF `locale` corresponds to the same language as `bundle.getLocale()`.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

preservingLocaleIfAllowed

public static SoyMsgBundle preservingLocaleIfAllowed(SoyMsgBundle bundle,
                                                     Locale locale)

Returns a soy message bundle that exposes `locale` as its locale IF `locale` corresponds to the same language as `bundle.getLocale()`. Intuitively, the returned bundle retains the passed-in locale if it's compatible with the passed-in translation bundle.

Examples

• If our translation bundle includes "es-419" (Spanish Latin America) but not "es-MX" (Spanish Mexico) specifically, then the returned bundle would use the translations for "es-419", but still expose "es-MX" as its locale to soy plugins for accurate localization.
• If, for a completely unsupported language, the passed-in bundle is the default one with "en" locale, then the returned bundle exposes "en" for localization.

getLocaleString

public String getLocaleString()

Description copied from class: SoyMsgBundle

Gets the language/locale string of this bundle of messages.

Specified by:

getLocaleString in class SoyMsgBundle

Returns:

The language/locale string of the messages provided by this bundle.

getLocale

public com.ibm.icu.util.ULocale getLocale()

Description copied from class: SoyMsgBundle

Returns the ULocale of this message bundle. Subclasses are encouraged to override this to provide efficient implementations.

Overrides:

getLocale in class SoyMsgBundle

isRtl

public boolean isRtl()

Description copied from class: SoyMsgBundle

Returns true if this is an RTL (right-to-left) locale. Subclasses are encouraged to override this to provide efficient implementations.

Overrides:

isRtl in class SoyMsgBundle

getMsg

public SoyMsg getMsg(long msgId)

Description copied from class: SoyMsgBundle

Retrieves a message by its unique message id.

Specified by:

getMsg in class SoyMsgBundle

Parameters:

msgId - The message id of the message to retrieve.

Returns:

The corresponding message, or null if not found.

getMsgParts

public com.google.common.collect.ImmutableList<SoyMsgPart> getMsgParts(long msgId)

Description copied from class: SoyMsgBundle

Returns the message parts, or an empty array if there is no such message.

This is useful for rendering only usecases when the rest of the SoyMsg doesn't matter. The default implementation is just SoyMsg.getParts() but some subclasses may have more efficient implementations

Overrides:

getMsgParts in class SoyMsgBundle

getNumMsgs

public int getNumMsgs()

Description copied from class: SoyMsgBundle

Gets the number of messages in this bundle.

Specified by:

getNumMsgs in class SoyMsgBundle

Returns:

The number of messages in this bundle.

iterator

public Iterator<SoyMsg> iterator()

Description copied from class: SoyMsgBundle

Returns an iterator over all the messages.

Specified by:

iterator in interface Iterable<SoyMsg>

Specified by:

iterator in class SoyMsgBundle

Returns:

An iterator over all the messages.

getInnerSoyMsgBundle

public SoyMsgBundle getInnerSoyMsgBundle()