com.google.template.soy.msgs

Class SoyMsgBundle

java.lang.Object

com.google.template.soy.msgs.SoyMsgBundle

All Implemented Interfaces:

Iterable<SoyMsg>

Direct Known Subclasses:

SoyMsgBundleImpl, SoyMsgBundleWithFullLocale

public abstract class SoyMsgBundle
extends Object
implements Iterable<SoyMsg>

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

Field Summary

Fields

Modifier and Type	Field and Description
static SoyMsgBundle	EMPTY Null object for SoyMsgBundle, assumes English Locale.

Constructor Summary

Constructors

Constructor and Description
SoyMsgBundle()

Method Summary

Modifier and Type	Method and Description
com.ibm.icu.util.ULocale	getLocale() Returns the ULocale of this message bundle.
abstract String	getLocaleString() Gets the language/locale string of this bundle of messages.
abstract 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.
abstract int	getNumMsgs() Gets the number of messages in this bundle.
boolean	isRtl() Returns true if this is an RTL (right-to-left) locale.
abstract Iterator<SoyMsg>	iterator() Returns an iterator over all the messages.

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

Field Detail

EMPTY

public static final SoyMsgBundle EMPTY

Null object for SoyMsgBundle, assumes English Locale.

Constructor Detail

SoyMsgBundle

public SoyMsgBundle()

Method Detail

getLocaleString

@Nullable
public abstract String getLocaleString()

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

Returns:

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

isRtl

public boolean isRtl()

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

getLocale

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

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

getMsgParts

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

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

getMsg

public abstract SoyMsg getMsg(long msgId)

Retrieves a message by its unique message id.

Parameters:

msgId - The message id of the message to retrieve.

Returns:

The corresponding message, or null if not found.

getNumMsgs

public abstract int getNumMsgs()

Gets the number of messages in this bundle.

Returns:

The number of messages in this bundle.

iterator

public abstract Iterator<SoyMsg> iterator()

Returns an iterator over all the messages.

Specified by:

iterator in interface Iterable<SoyMsg>

Returns:

An iterator over all the messages.