com.google.template.soy.soytree

Class CallParamValueNode

java.lang.Object

com.google.template.soy.basetree.AbstractNode

com.google.template.soy.soytree.AbstractSoyNode

com.google.template.soy.soytree.CallParamNode

com.google.template.soy.soytree.CallParamValueNode

All Implemented Interfaces:

Node, SoyNode, SoyNode.CommandNode, SoyNode.ExprHolderNode

public final class CallParamValueNode
extends CallParamNode
implements SoyNode.ExprHolderNode

Node representing a 'param' with a value expression.

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

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.MsgBlockNode, SoyNode.MsgPlaceholderInitialNode, SoyNode.MsgSubstUnitNode, SoyNode.ParentSoyNode<N extends SoyNode>, SoyNode.RenderUnitNode, SoyNode.SplitLevelTopNode<N extends SoyNode>, SoyNode.StandaloneNode, SoyNode.StatementNode

Constructor Summary

Constructors

Constructor and Description
CallParamValueNode(int id, SourceLocation location, Identifier key, ExprNode valueExpr)

Method Summary

Modifier and Type	Method and Description
CallParamValueNode	copy(CopyState copyState) Copies this node.
String	getCommandName() Returns the Soy command name.
String	getCommandText() Returns the command text (may be the empty string).
ExprRootNode	getExpr() Returns the parsed expression for the param value.
com.google.common.collect.ImmutableList<ExprRootNode>	getExprList() Returns the list of expressions in this node.
SoyNode.Kind	getKind() Returns this node's kind (corresponding to this node's specific type).
String	getTagString()
protected String	getTagString(boolean selfEnding)
String	toSourceString() Builds a Soy source string that could be the source for this node.

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

getKey, getParent

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, equals, getNearestAncestor, getSyntaxVersionUpperBound, hasAncestor, hashCode, maybeSetSyntaxVersionUpperBound, setParent

Methods inherited from class java.lang.Object

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

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

getId, getParent, setId

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

couldHaveSyntaxVersionAtLeast, getNearestAncestor, getSourceLocation, getSyntaxVersionUpperBound, hasAncestor, maybeSetSyntaxVersionUpperBound, setParent, toSourceString

Constructor Detail

CallParamValueNode

public CallParamValueNode(int id,
                          SourceLocation location,
                          Identifier key,
                          ExprNode valueExpr)

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

getExpr

public ExprRootNode getExpr()

Returns the parsed expression for the param value.

getCommandText

public String getCommandText()

Description copied from interface: SoyNode.CommandNode

Returns the command text (may be the empty string).

Specified by:

getCommandText in interface SoyNode.CommandNode

getTagString

public String getTagString()

Returns:

A Soy tag string that could be the Soy tag for this node. Note that this may not necessarily be the actual original Soy tag, but a (sort of) canonical equivalent.

getExprList

public com.google.common.collect.ImmutableList<ExprRootNode> getExprList()

Description copied from interface: SoyNode.ExprHolderNode

Returns the list of expressions in this node.

Specified by:

getExprList in interface SoyNode.ExprHolderNode

copy

public CallParamValueNode copy(CopyState copyState)

Description copied from interface: SoyNode

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

All copy() 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 copy(CopyState copyState) {
     return new T(this, copyState);
   }
   

• all non-leaf copy constructors should be protected

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

Don't clone nodes unless you know what you're doing. The Soy AST is not actually a tree (it contains back edges from variables to their definitions), and naively copying nodes can result in pointers into stale ASTs

The copied nodes will have the same ids as the original nodes. If you need to copy a subtree with new ids assigned to the copied nodes, use SoyTreeUtils.cloneWithNewIds(T, com.google.template.soy.base.internal.IdGenerator).

Specified by:

copy in interface Node

Specified by:

copy in interface SoyNode

Returns:

A clone of this code.

getCommandName

public String getCommandName()

Description copied from interface: SoyNode.CommandNode

Returns the Soy command name.

Specified by:

getCommandName in interface SoyNode.CommandNode

getTagString

protected final String getTagString(boolean selfEnding)

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, NOT QUITE) 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.