com.google.template.soy.msgs.restricted

Class SoyMsgBundleImpl

java.lang.Object

com.google.template.soy.msgs.SoyMsgBundle

com.google.template.soy.msgs.restricted.SoyMsgBundleImpl

All Implemented Interfaces:

Iterable<SoyMsg>

public class SoyMsgBundleImpl
extends SoyMsgBundle

Represents a full set of messages in some language/locale.

Important: Only use this class from message plugins!

Field Summary

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

EMPTY

Constructor Summary

Constructors

Constructor and Description
SoyMsgBundleImpl(String localeString, List<SoyMsg> msgs) Note: If there exist duplicate message ids in the msgs list, the first one wins.

Method Summary

Modifier and Type	Method and Description
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.
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.

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

getMsgParts

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

Constructor Detail

SoyMsgBundleImpl

public SoyMsgBundleImpl(@Nullable
                        String localeString,
                        List<SoyMsg> msgs)

Note: If there exist duplicate message ids in the msgs list, the first one wins. However, the source paths from subsequent duplicates will be added to the source paths for the message.

Parameters:

localeString - The language/locale string of this bundle of messages, or null if unknown. Should only be null for bundles newly extracted from source files. Should always be set for bundles parsed from message files/resources.

msgs - The list of messages. List order will become the iteration order.

Method Detail

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

@Nullable
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.

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.