com.google.template.soy.msgs.restricted

Class SoyMsg

java.lang.Object

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

public final class SoyMsg
extends Object

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

Constructor Summary

Constructors

Constructor and Description
SoyMsg(long id, long altId, String localeString, String meaning, String desc, boolean isHidden, String contentType, String sourcePath, boolean isPlrselMsg, List<SoyMsgPart> parts)
SoyMsg(long id, String localeString, boolean isPlrselMsg, List<SoyMsgPart> parts) Constructor with just enough information for rendering only.
SoyMsg(long id, String localeString, String meaning, String desc, boolean isHidden, String contentType, String sourcePath, List<SoyMsgPart> parts)

Method Summary

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

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SoyMsg

public SoyMsg(long id,
              long altId,
              @Nullable
              String localeString,
              @Nullable
              String meaning,
              @Nullable
              String desc,
              boolean isHidden,
              @Nullable
              String contentType,
              @Nullable
              String sourcePath,
              boolean isPlrselMsg,
              List<SoyMsgPart> parts)

Parameters:

id - A unique id for this message (same across all translations).

altId - An alternate unique id for this message, or -1L if not applicable.

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

meaning - The meaning string, or null if not necessary (usually null). This is a string to create unique messages for two otherwise identical messages. This is usually done for messages used in different contexts. (For example, the same word can be used as a noun in one location and as a verb in another location, and the message texts would be the same but the messages would have meanings of "noun" and "verb".). May not be applicable to all message plugins.

desc - The description for translators.

isHidden - Whether this message should be hidden. May not be applicable to all message plugins.

contentType - Content type of the document that this message will appear in (e.g. "text/html"). May not be applicable to all message plugins.

sourcePath - Location of a source file that this message comes from. More sources can be added using addSourcePath(). May not be applicable to all message plugins.

isPlrselMsg - Whether this is a plural/select message.

parts - The parts that make up the message content.

SoyMsg

public SoyMsg(long id,
              @Nullable
              String localeString,
              @Nullable
              String meaning,
              @Nullable
              String desc,
              boolean isHidden,
              @Nullable
              String contentType,
              @Nullable
              String sourcePath,
              List<SoyMsgPart> parts)

Parameters:

id - A unique id for this message (same across all translations).

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

meaning - The meaning string, or null if not necessary (usually null). This is a string to create unique messages for two otherwise identical messages. This is usually done for messages used in different contexts. (For example, the same word can be used as a noun in one location and as a verb in another location, and the message texts would be the same but the messages would have meanings of "noun" and "verb".). May not be applicable to all message plugins.

desc - The description for translators.

isHidden - Whether this message should be hidden. May not be applicable to all message plugins.

contentType - Content type of the document that this message will appear in (e.g. "text/html"). May not be applicable to all message plugins.

sourcePath - Location of a source file that this message comes from. More sources can be added using addSourcePath(). May not be applicable to all message plugins.

parts - The parts that make up the message content.

SoyMsg

public SoyMsg(long id,
              @Nullable
              String localeString,
              boolean isPlrselMsg,
              List<SoyMsgPart> parts)

Constructor with just enough information for rendering only.

Parameters:

id - A unique id for this message (same across all translations).

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

isPlrselMsg - Whether this is a plural/select message.

parts - The parts that make up the message content.

Method Detail

getLocaleString

public String getLocaleString()

Returns the language/locale string.

getId

public long getId()

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

getAltId

public long getAltId()

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

getMeaning

public String getMeaning()

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

getDesc

public String getDesc()

Returns the description for translators.

isHidden

public boolean isHidden()

Returns whether this message should be hiddens.

getContentType

public String getContentType()

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

addSourcePath

public void addSourcePath(String sourcePath)

Parameters:

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

getSourcePaths

public com.google.common.collect.ImmutableSet<String> getSourcePaths()

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

isPlrselMsg

public boolean isPlrselMsg()

Returns whether this is a plural/select message.

getParts

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

Returns the parts that make up the message content.

equals

public boolean equals(Object otherObject)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object