com.google.template.soy.soytree.jssrc

Class GoogMsgDefNode

java.lang.Object

com.google.template.soy.basetree.AbstractNode

com.google.template.soy.soytree.AbstractSoyNode

com.google.template.soy.soytree.AbstractParentSoyNode<MsgNode>

com.google.template.soy.soytree.jssrc.GoogMsgDefNode

All Implemented Interfaces:

Node, ParentNode<MsgNode>, SoyNode, SoyNode.LocalVarInlineNode, SoyNode.LocalVarNode, SoyNode.ParentSoyNode<MsgNode>, SoyNode.SplitLevelTopNode<MsgNode>, SoyNode.StandaloneNode

public final class GoogMsgDefNode
extends AbstractParentSoyNode<MsgNode>
implements SoyNode.StandaloneNode, SoyNode.SplitLevelTopNode<MsgNode>, SoyNode.LocalVarInlineNode

Represents a goog.getMsg* definition of a group of one or more messages. If more than one message, then they form a fallback list (first message that has a translation will be shown).

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

All children are MsgNodes.

Nested Class Summary

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

Constructor Summary

Constructors

Constructor and Description
GoogMsgDefNode(int id, MsgFallbackGroupNode origMsgFbGrpNode, List<Long> childMsgIds) Regular constructor.

Method Summary

Modifier and Type	Method and Description
GoogMsgDefNode	clone() Copies this node.
long	getChildMsgId(MsgNode child) Returns the msg id for the given child.
SoyNode.Kind	getKind() Returns this node's kind (corresponding to this node's specific type).
SoyNode.BlockNode	getParent() Gets this node's parent.
String	getRenderedGoogMsgVarName() Returns the JS var name of the rendered goog msg.
String	getVarName() Returns the name of this node's local variable (without the preceding '$').
String	toSourceString() Builds a Soy source string that could be the source for this node.

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

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.AbstractSoyNode

getId, getSourceLocation, setId, 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.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.soytree.SoyNode

getId, setId

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

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

Constructor Detail

GoogMsgDefNode

public GoogMsgDefNode(int id,
                      MsgFallbackGroupNode origMsgFbGrpNode,
                      List<Long> childMsgIds)

Regular constructor. Note that this new node is meant to replace origMsgFbGrpNode, so this constructor will simply move the children from origMsgFbGrpNode to this new node (i.e. origMsgFbGrpNode is destructively modified).

Parameters:

id - The id for this node.

origMsgFbGrpNode - The original MsgFallbackGroupNode that this node is based off. Note this original node will be destructively modified.

childMsgIds - The list of child msg ids (must correspond to children of origMsgFbGrpNode by index).

Method Detail

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

getChildMsgId

public long getChildMsgId(MsgNode child)

Returns the msg id for the given child.

getRenderedGoogMsgVarName

public String getRenderedGoogMsgVarName()

Returns the JS var name of the rendered goog msg.

getVarName

public String getVarName()

Description copied from interface: SoyNode.LocalVarNode

Returns the name of this node's local variable (without the preceding '$').

Specified by:

getVarName in interface SoyNode.LocalVarNode

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

Returns:

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

getParent

public SoyNode.BlockNode getParent()

Description copied from interface: Node

Gets this node's parent.

Specified by:

getParent in interface Node

Specified by:

getParent in interface SoyNode

Specified by:

getParent in interface SoyNode.StandaloneNode

Overrides:

getParent in class AbstractSoyNode

Returns:

This node's parent.

clone

public GoogMsgDefNode 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.