com.google.template.soy.soytree

Class MsgNode

java.lang.Object

com.google.template.soy.basetree.AbstractNode

com.google.template.soy.soytree.AbstractSoyNode

com.google.template.soy.soytree.AbstractCommandNode

com.google.template.soy.soytree.AbstractParentCommandNode<SoyNode.StandaloneNode>

com.google.template.soy.soytree.AbstractBlockCommandNode

com.google.template.soy.soytree.MsgNode

All Implemented Interfaces:

Node, ParentNode<SoyNode.StandaloneNode>, SoyNode, SoyNode.BlockCommandNode, SoyNode.BlockNode, SoyNode.CommandNode, SoyNode.ExprHolderNode, SoyNode.MsgBlockNode, SoyNode.ParentSoyNode<SoyNode.StandaloneNode>

public final class MsgNode
extends AbstractBlockCommandNode
implements SoyNode.ExprHolderNode, SoyNode.MsgBlockNode

Node representing a 'msg' block. Every child must be a RawTextNode, MsgPlaceholderNode, MsgPluralNode, or MsgSelectNode.

Important: Do not use outside of Soy code (treat as superpackage-private).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MsgNode.Builder Builder for MsgNode.

Nested classes/interfaces inherited from interface com.google.template.soy.soytree.SoyNode

SoyNode.BlockCommandNode, SoyNode.BlockNode, SoyNode.CommandNode, SoyNode.ConditionalBlockNode, SoyNode.ExprHolderNode, SoyNode.Kind, SoyNode.LocalVarBlockNode, SoyNode.LocalVarInlineNode, SoyNode.LocalVarNode, SoyNode.LoopNode, SoyNode.MsgBlockNode, SoyNode.MsgPlaceholderInitialNode, SoyNode.MsgSubstUnitNode, SoyNode.ParentSoyNode<N extends SoyNode>, SoyNode.RenderUnitNode, SoyNode.SplitLevelTopNode<N extends SoyNode>, SoyNode.StandaloneNode, SoyNode.StatementNode

Field Summary

Fields inherited from class com.google.template.soy.basetree.AbstractNode

SPACES

Method Summary

Modifier and Type	Method and Description
MsgNode	clone() Copies this node.
static MsgNode.Builder	fallbackmsg(int id, String commandText, SourceLocation sourceLocation) Returns a new MsgNode.Builder representing a fallbackmsg MsgNode.
List<ExprUnion>	getAllExprUnions() Returns the list of expressions in this node.
List<ExprRootNode<?>>	getAndRemoveGenderExprs() Returns the list of expressions for gender values and sets that field to null.
String	getContentType() Returns the content type for the TC.
String	getDesc() Returns the description string for translators.
SoyNode.Kind	getKind() Returns this node's kind (corresponding to this node's specific type).
String	getMeaning() Returns the meaning string if set, otherwise null (usually null).
String	getPlaceholderName(MsgPlaceholderNode placeholderNode) Gets the placeholder name for a given placeholder node.
String	getPluralVarName(MsgPluralNode pluralNode) Gets the variable name associated with a given plural node.
MsgPlaceholderNode	getRepPlaceholderNode(String placeholderName) Gets the representative placeholder node for a given placeholder name.
MsgPluralNode	getRepPluralNode(String pluralVarName) Gets the representative plural node for a given plural variable name.
MsgSelectNode	getRepSelectNode(String selectVarName) Gets the representative select node for a given select variable name.
String	getSelectVarName(MsgSelectNode selectNode) Gets the variable name associated with a given select node.
com.google.common.collect.ImmutableMap<String,SoyNode.MsgSubstUnitNode>	getVarNameToRepNodeMap() Getter for the generated map from substitution unit var name to representative node.
boolean	isHidden() Returns whether the message should be added as 'hidden' in the TC.
boolean	isPlrselMsg() Returns whether this is a plural or select message.
boolean	isPluralMsg() Returns whether this is a plural message.
boolean	isRawTextMsg() Returns whether this is a raw text message.
boolean	isSelectMsg() Returns whether this is a select message.
static MsgNode.Builder	msg(int id, String commandText, SourceLocation sourceLocation) Returns a new MsgNode.Builder representing a msg MsgNode.
String	toSourceString() Builds a Soy source string that could be the source for this node.

Methods inherited from class com.google.template.soy.soytree.AbstractParentCommandNode

addChild, addChild, addChildren, addChildren, appendSourceStringForChildren, appendTreeStringForChildren, clearChildren, getChild, getChildIndex, getChildren, numChildren, removeChild, removeChild, replaceChild, replaceChild, toTreeString

Methods inherited from class com.google.template.soy.soytree.AbstractCommandNode

buildTagStringHelper, buildTagStringHelper, getCommandName, getCommandText, getTagString

Methods inherited from class com.google.template.soy.soytree.AbstractSoyNode

getId, getParent, getSourceLocation, setId, setSourceLocation, toString

Methods inherited from class com.google.template.soy.basetree.AbstractNode

couldHaveSyntaxVersionAtLeast, getNearestAncestor, getSyntaxVersionBound, hasAncestor, maybeSetSyntaxVersionBound, setParent

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.google.template.soy.soytree.SoyNode

getId, getSourceLocation, setId, setSourceLocation

Methods inherited from interface com.google.template.soy.basetree.ParentNode

addChild, addChild, addChildren, addChildren, appendSourceStringForChildren, appendTreeStringForChildren, clearChildren, getChild, getChildIndex, getChildren, numChildren, removeChild, removeChild, replaceChild, replaceChild

Methods inherited from interface com.google.template.soy.basetree.Node

couldHaveSyntaxVersionAtLeast, getNearestAncestor, getSyntaxVersionBound, hasAncestor, maybeSetSyntaxVersionBound, setParent, toTreeString

Methods inherited from interface com.google.template.soy.soytree.SoyNode.CommandNode

getCommandName, getCommandText, getTagString

Method Detail

msg

public static MsgNode.Builder msg(int id,
                                  String commandText,
                                  SourceLocation sourceLocation)

Returns a new MsgNode.Builder representing a msg MsgNode.

Parameters:

id - The node's id.

commandText - The node's command text.

sourceLocation - The node's source location.

fallbackmsg

public static MsgNode.Builder fallbackmsg(int id,
                                          String commandText,
                                          SourceLocation sourceLocation)

Returns a new MsgNode.Builder representing a fallbackmsg MsgNode.

Parameters:

id - The node's id.

commandText - The node's command text.

sourceLocation - The node's source location.

getKind

public SoyNode.Kind getKind()

Description copied from interface: SoyNode

Returns this node's kind (corresponding to this node's specific type).

Specified by:

getKind in interface SoyNode

getAndRemoveGenderExprs

@Nullable
public List<ExprRootNode<?>> getAndRemoveGenderExprs()

Returns the list of expressions for gender values and sets that field to null. Note that this node's command text will still contain the substring genders="...". We think this is okay since the command text is only used for reporting errors (in fact, it might be good as a reminder of how the msg was originally written).

getAllExprUnions

public List<ExprUnion> getAllExprUnions()

Description copied from interface: SoyNode.ExprHolderNode

Returns the list of expressions in this node.

Specified by:

getAllExprUnions in interface SoyNode.ExprHolderNode

getMeaning

public String getMeaning()

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

getDesc

public String getDesc()

Returns the description string for translators.

isHidden

public boolean isHidden()

Returns whether the message should be added as 'hidden' in the TC.

getContentType

public String getContentType()

Returns the content type for the TC.

isPlrselMsg

public boolean isPlrselMsg()

Returns whether this is a plural or select message.

isSelectMsg

public boolean isSelectMsg()

Returns whether this is a select message.

isPluralMsg

public boolean isPluralMsg()

Returns whether this is a plural message.

isRawTextMsg

public boolean isRawTextMsg()

Returns whether this is a raw text message.

getRepPlaceholderNode

public MsgPlaceholderNode getRepPlaceholderNode(String placeholderName)

Gets the representative placeholder node for a given placeholder name.

Parameters:

placeholderName - The placeholder name.

Returns:

The representative placeholder node for the given placeholder name.

getPlaceholderName

public String getPlaceholderName(MsgPlaceholderNode placeholderNode)

Gets the placeholder name for a given placeholder node.

Parameters:

placeholderNode - The placeholder node.

Returns:

The placeholder name for the given placeholder node.

getRepPluralNode

public MsgPluralNode getRepPluralNode(String pluralVarName)

Gets the representative plural node for a given plural variable name.

Parameters:

pluralVarName - The plural variable name.

Returns:

The representative plural node for the given plural variable name.

getPluralVarName

public String getPluralVarName(MsgPluralNode pluralNode)

Gets the variable name associated with a given plural node.

Parameters:

pluralNode - The plural node.

Returns:

The plural variable name for the given plural node.

getRepSelectNode

public MsgSelectNode getRepSelectNode(String selectVarName)

Gets the representative select node for a given select variable name.

Parameters:

selectVarName - The select variable name.

Returns:

The representative select node for the given select variable name.

getSelectVarName

public String getSelectVarName(MsgSelectNode selectNode)

Gets the variable name associated with a given select node.

Parameters:

selectNode - The select node.

Returns:

The select variable name for the given select node.

getVarNameToRepNodeMap

public com.google.common.collect.ImmutableMap<String,SoyNode.MsgSubstUnitNode> getVarNameToRepNodeMap()

Getter for the generated map from substitution unit var name to representative node.

toSourceString

public String toSourceString()

Description copied from interface: Node

Builds a Soy source string that could be the source for this node. Note that this is not the actual original source string, but a (sort of) canonical equivalent. Note: Some nodes do not have a direct mapping to Soy source (such as nodes created during some optimization passes). Thus this method may not always be supported.

Specified by:

toSourceString in interface Node

Overrides:

toSourceString in class AbstractParentCommandNode<SoyNode.StandaloneNode>

Returns:

A Soy string that could be the source for this node.

clone

public MsgNode clone()

Description copied from interface: Node

Copies this node. The clone's parent pointer is set to null.

All clone() overrides should follow this contract:

• only leaf classes (in the class hierarchy) should have non-abstract clone methods
• all leaf classes should be final
• all leaf copy constructors should be private
• all clone methods should look exactly like:

  
      {@literal @}Override public T clone() {
        return new T(this);
      }
   

• all non-leaf copy constructors should be protected

NOTE: this means we do not ultimately delegate to Object.clone(), ever.

TODO(lukes): The usecases for a clone method are few and far between. Making the AST nodes immutable (or at least unmodifiable) would be preferable to maintaining our clone() methods.

Specified by:

clone in interface Node

Specified by:

clone in interface SoyNode

Specified by:

clone in class AbstractSoyNode

Returns:

A clone of this code.