com.google.template.soy.msgs.restricted

Class SoyMsg

java.lang.Object

com.google.template.soy.msgs.restricted.SoyMsg

@DoNotMock(value="use the builder() instead to construct a real instance")
public abstract class SoyMsg
extends Object

Represents a message in some language/locale. Contains information relevant to translation.

This class is heavily optimized for memory usage. In one major server using SoyTofu, Soy messages comprised the single largest category of memory usage prior to optimization. Several fields can be omitted entirely for render-only usage. ImmutableSet and ImmutableList are used because their empty implementations are singletons.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SoyMsg.Builder A builder for SoyMsg.

Constructor Summary

Constructors

Constructor and Description
SoyMsg()

Method Summary

Modifier and Type	Method and Description
void	addSourceLocation(SourceLocation sourceLocation)
static SoyMsg.Builder	builder() Returns a new builder for SoyMsg.
abstract long	getAltId() Returns the alternate unique id for this message, or -1L if not applicable.
abstract String	getContentType() Returns the content type of the document that this message will appear in.
abstract String	getDesc() Returns the description for translators.
abstract long	getId() Returns the unique id for this message (same across all translations).
abstract String	getLocaleString() Returns the language/locale string.
abstract String	getMeaning() Returns the meaning string if set, otherwise null (usually null).
abstract com.google.common.collect.ImmutableList<SoyMsgPart>	getParts() Returns the parts that make up the message content.
com.google.common.collect.ImmutableSet<SourceLocation>	getSourceLocations() Returns the location(s) of the source file(s) that this message comes from.
abstract boolean	isHidden() Returns whether this message should be hidden.
abstract boolean	isPlrselMsg() Returns whether this is a plural/select message.

Methods inherited from class java.lang.Object

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

Constructor Detail

SoyMsg

public SoyMsg()

Method Detail

builder

public static SoyMsg.Builder builder()

Returns a new builder for SoyMsg.

getLocaleString

@Nullable
public abstract String getLocaleString()

Returns the language/locale string.

getId

public abstract long getId()

Returns the unique id for this message (same across all translations).

getAltId

public abstract long getAltId()

Returns the alternate unique id for this message, or -1L if not applicable.

getMeaning

@Nullable
public abstract String getMeaning()

Returns the meaning string if set, otherwise null (usually null).

getDesc

@Nullable
public abstract String getDesc()

Returns the description for translators.

isHidden

public abstract boolean isHidden()

Returns whether this message should be hidden.

getContentType

@Nullable
public abstract String getContentType()

Returns the content type of the document that this message will appear in.

addSourceLocation

public void addSourceLocation(SourceLocation sourceLocation)

Parameters:

sourceLocation - Location of a source file that this message comes from.

getSourceLocations

public com.google.common.collect.ImmutableSet<SourceLocation> getSourceLocations()

Returns the location(s) of the source file(s) that this message comes from.

isPlrselMsg

public abstract boolean isPlrselMsg()

Returns whether this is a plural/select message.

getParts

public abstract com.google.common.collect.ImmutableList<SoyMsgPart> getParts()

Returns the parts that make up the message content.