com.google.template.soy.msgs

Interface SoyMsgBundle

All Superinterfaces:

Iterable<SoyMsg>

All Known Implementing Classes:

SoyMsgBundleImpl

public interface SoyMsgBundle
extends 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.

Method Summary

Modifier and Type	Method and Description
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.
Iterator<SoyMsg>	iterator() Returns an iterator over all the messages.

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

EMPTY

static final SoyMsgBundle EMPTY

Null object for SoyMsgBundle, assumes English Locale.

Method Detail

getLocaleString

String getLocaleString()

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

Returns:

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

getMsg

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

int getNumMsgs()

Gets the number of messages in this bundle.

Returns:

The number of messages in this bundle.

iterator

Iterator<SoyMsg> iterator()

Returns an iterator over all the messages.

Specified by:

iterator in interface Iterable<SoyMsg>

Returns:

An iterator over all the messages.