com.google.template.soy.msgs.restricted

Class SoyMsg.Builder

java.lang.Object

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

Enclosing class:

SoyMsg

public static final class SoyMsg.Builder
extends Object

A builder for SoyMsg.

Method Summary

Modifier and Type	Method and Description
SoyMsg	build()
SoyMsg.Builder	setAltId(long altId)
SoyMsg.Builder	setContentType(String contentType)
SoyMsg.Builder	setDesc(String desc)
SoyMsg.Builder	setId(long id)
SoyMsg.Builder	setIsHidden(boolean isHidden)
SoyMsg.Builder	setIsPlrselMsg(boolean isPlrselMsg)
SoyMsg.Builder	setLocaleString(String localeString)
SoyMsg.Builder	setMeaning(String meaning)
SoyMsg.Builder	setParts(Iterable<? extends SoyMsgPart> parts)
SoyMsg.Builder	setSourceLocation(SourceLocation sourceLocation)

Methods inherited from class java.lang.Object

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

Method Detail

setId

public SoyMsg.Builder setId(long id)

Parameters:

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

setAltId

public SoyMsg.Builder setAltId(long altId)

Parameters:

altId - An alternate unique id for this message.

setLocaleString

public SoyMsg.Builder setLocaleString(String localeString)

Parameters:

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

setMeaning

public SoyMsg.Builder setMeaning(String meaning)

Parameters:

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.

setDesc

public SoyMsg.Builder setDesc(String desc)

Parameters:

desc - The description for translators.

setIsHidden

public SoyMsg.Builder setIsHidden(boolean isHidden)

Parameters:

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

setContentType

public SoyMsg.Builder setContentType(String contentType)

Parameters:

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

setSourceLocation

public SoyMsg.Builder setSourceLocation(SourceLocation sourceLocation)

Parameters:

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

setIsPlrselMsg

public SoyMsg.Builder setIsPlrselMsg(boolean isPlrselMsg)

Parameters:

isPlrselMsg - Whether this is a plural/select message.

setParts

public SoyMsg.Builder setParts(Iterable<? extends SoyMsgPart> parts)

Parameters:

parts - The parts that make up the message content.

build

public SoyMsg build()