com.google.template.soy.soytree

Class CallNode

java.lang.Object

com.google.template.soy.basetree.AbstractNode

com.google.template.soy.soytree.AbstractSoyNode

com.google.template.soy.soytree.CallNode

All Implemented Interfaces:

Node, ParentNode<CallParamNode>, SoyNode, SoyNode.CommandNode, SoyNode.ExprHolderNode, SoyNode.MsgPlaceholderInitialNode, SoyNode.ParentSoyNode<CallParamNode>, SoyNode.SplitLevelTopNode<CallParamNode>, SoyNode.StandaloneNode, SoyNode.StatementNode

Direct Known Subclasses:

CallBasicNode, CallDelegateNode

public abstract class CallNode
extends AbstractSoyNode
implements SoyNode.StandaloneNode, SoyNode.SplitLevelTopNode<CallParamNode>, SoyNode.StatementNode, SoyNode.ExprHolderNode, SoyNode.MsgPlaceholderInitialNode

Node representing a call.

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CallNode(CallNode orig, CopyState copyState) Copy constructor.
protected	CallNode(int id, SourceLocation location, String commandName, List<CommandTagAttribute> attributes, ErrorReporter reporter) Protected constructor for use by subclasses.

Method Summary

Modifier and Type	Method and Description
void	addChild(int index, N child) Adds the given child at the given index (shifting existing children if necessary).
void	addChild(N child) Adds the given child.
void	addChildren(int index, List<? extends N> children) Adds the given children at the given index (shifting existing children if necessary).
void	addChildren(List<? extends N> children) Adds the given children.
void	appendSourceStringForChildren(StringBuilder sb) Appends the source strings for all the children to the given StringBuilder.
void	clearChildren() Clears the list of children.
String	genBasePhName() Generates the base placeholder name for this node.
Object	genSamenessKey() Generates the key object used in comparisons to determine whether two placeholder nodes should be represented by the same placeholder.
N	getChild(int index) Gets the child at the given index.
int	getChildIndex(Node child) Finds the index of the given child.
List<N>	getChildren() Gets the list of children.
String	getCommandName() Returns the Soy command name.
String	getCommandText() Returns the command text (may be the empty string).
ExprRootNode	getDataExpr()
com.google.common.collect.ImmutableList<SoyPrintDirective>	getEscapingDirectives() Returns the escaping directives, applied from left to right.
com.google.common.collect.ImmutableList<ExprRootNode>	getExprList() Returns the list of expressions in this node.
boolean	getIsPcData()
abstract com.google.common.collect.ImmutableList<TemplateParam>	getParamsToRuntimeCheck(TemplateNode callee) Returns the subset of params of the callee that require runtime type checking when this node is being rendered.
SoyNode.ParentSoyNode<SoyNode.StandaloneNode>	getParent() Gets this node's parent.
String	getTagString()
protected String	getTagString(boolean selfEnding)
String	getUserSuppliedPhExample() Gets the user-supplied placeholder example, or null if not supplied or not applicable.
String	getUserSuppliedPhName() Gets the user-supplied placeholder name, or null if not supplied or not applicable.
boolean	isPassingAllData()
boolean	isPassingData()
int	numChildren() Gets the number of children.
void	removeChild(int index) Removes the child at the given index.
void	removeChild(N child) Removes the given child.
void	replaceChild(int index, N newChild) Replaces the child at the given index with the given new child.
void	replaceChild(N currChild, N newChild) Replaces the given current child with the given new child.
void	setEscapingDirectives(com.google.common.collect.ImmutableList<SoyPrintDirective> escapingDirectives) Sets the inferred escaping directives.
void	setIsPcData(boolean isPcData)
String	toSourceString() Builds a Soy source string that could be the source for this node.

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.basetree.ParentNode

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

Constructor Detail

CallNode

protected CallNode(int id,
                   SourceLocation location,
                   String commandName,
                   List<CommandTagAttribute> attributes,
                   ErrorReporter reporter)

Protected constructor for use by subclasses.

CallNode

protected CallNode(CallNode orig,
                   CopyState copyState)

Copy constructor.

Parameters:

orig - The node to copy.

Method Detail

isPassingData

public boolean isPassingData()

isPassingAllData

public boolean isPassingAllData()

getDataExpr

@Nullable
public ExprRootNode getDataExpr()

getIsPcData

public boolean getIsPcData()

setIsPcData

public void setIsPcData(boolean isPcData)

getUserSuppliedPhName

@Nullable
public String getUserSuppliedPhName()

Description copied from interface: SoyNode.MsgPlaceholderInitialNode

Gets the user-supplied placeholder name, or null if not supplied or not applicable. Note that this raw name can be any identifier (not necessarily in upper-underscore format).

Specified by:

getUserSuppliedPhName in interface SoyNode.MsgPlaceholderInitialNode

Returns:

The user-supplied placeholder name, or null if not supplied or not applicable.

getUserSuppliedPhExample

@Nullable
public String getUserSuppliedPhExample()

Description copied from interface: SoyNode.MsgPlaceholderInitialNode

Gets the user-supplied placeholder example, or null if not supplied or not applicable.

Specified by:

getUserSuppliedPhExample in interface SoyNode.MsgPlaceholderInitialNode

Returns:

The user-supplied placeholder example, or null if not supplied or not applicable.

genBasePhName

public String genBasePhName()

Description copied from interface: SoyNode.MsgPlaceholderInitialNode

Generates the base placeholder name for this node.

Specified by:

genBasePhName in interface SoyNode.MsgPlaceholderInitialNode

Returns:

The base placeholder name for this node.

genSamenessKey

public Object genSamenessKey()

Description copied from interface: SoyNode.MsgPlaceholderInitialNode

Generates the key object used in comparisons to determine whether two placeholder nodes should be represented by the same placeholder.

Specified by:

genSamenessKey in interface SoyNode.MsgPlaceholderInitialNode

Returns:

The key object for determining whether this node and another node should be represented by the same placeholder.

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.

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.

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

getParent

public SoyNode.ParentSoyNode<SoyNode.StandaloneNode> 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.

getParamsToRuntimeCheck

public abstract com.google.common.collect.ImmutableList<TemplateParam> getParamsToRuntimeCheck(TemplateNode callee)

Returns the subset of params of the callee that require runtime type checking when this node is being rendered.

getEscapingDirectives

public com.google.common.collect.ImmutableList<SoyPrintDirective> getEscapingDirectives()

Returns the escaping directives, applied from left to right.

It is an error to call this before the contextual rewriter has been run.

setEscapingDirectives

public void setEscapingDirectives(com.google.common.collect.ImmutableList<SoyPrintDirective> escapingDirectives)

Sets the inferred escaping directives.

numChildren

public int numChildren()

Description copied from interface: ParentNode

Gets the number of children.

Specified by:

numChildren in interface ParentNode<N extends SoyNode>

Returns:

The number of children.

getChild

public N getChild(int index)

Description copied from interface: ParentNode

Gets the child at the given index.

Specified by:

getChild in interface ParentNode<N extends SoyNode>

Parameters:

index - The index of the child to get.

Returns:

The child at the given index.

getChildIndex

public int getChildIndex(Node child)

Description copied from interface: ParentNode

Finds the index of the given child.

Specified by:

getChildIndex in interface ParentNode<N extends SoyNode>

Parameters:

child - The child to find the index of.

Returns:

The index of the given child, or -1 if the given child is not a child of this node.

getChildren

public List<N> getChildren()

Description copied from interface: ParentNode

Gets the list of children.

Note: The returned list may not be a copy. Please do not modify the list directly. Instead, use the other methods in this class that are intended for modifying children. Also, if you're iterating over the children list as you're modifying it, then you should first make a copy of the children list to iterate over, in order to avoid ConcurrentModificationException.

Specified by:

getChildren in interface ParentNode<N extends SoyNode>

Returns:

The list of children.

addChild

public void addChild(N child)

Description copied from interface: ParentNode

Adds the given child.

Specified by:

addChild in interface ParentNode<N extends SoyNode>

Parameters:

child - The child to add.

addChild

public void addChild(int index,
                     N child)

Description copied from interface: ParentNode

Adds the given child at the given index (shifting existing children if necessary).

Specified by:

addChild in interface ParentNode<N extends SoyNode>

Parameters:

index - The index to add the child at.

child - The child to add.

removeChild

public void removeChild(int index)

Description copied from interface: ParentNode

Removes the child at the given index.

Specified by:

removeChild in interface ParentNode<N extends SoyNode>

Parameters:

index - The index of the child to remove.

removeChild

public void removeChild(N child)

Description copied from interface: ParentNode

Removes the given child.

Specified by:

removeChild in interface ParentNode<N extends SoyNode>

Parameters:

child - The child to remove.

replaceChild

public void replaceChild(int index,
                         N newChild)

Description copied from interface: ParentNode

Replaces the child at the given index with the given new child.

Specified by:

replaceChild in interface ParentNode<N extends SoyNode>

Parameters:

index - The index of the child to replace.

newChild - The new child.

replaceChild

public void replaceChild(N currChild,
                         N newChild)

Description copied from interface: ParentNode

Replaces the given current child with the given new child.

Specified by:

replaceChild in interface ParentNode<N extends SoyNode>

Parameters:

currChild - The current child to be replaced.

newChild - The new child.

clearChildren

public void clearChildren()

Description copied from interface: ParentNode

Clears the list of children.

Specified by:

clearChildren in interface ParentNode<N extends SoyNode>

addChildren

public void addChildren(List<? extends N> children)

Description copied from interface: ParentNode

Adds the given children.

Specified by:

addChildren in interface ParentNode<N extends SoyNode>

Parameters:

children - The children to add.

addChildren

public void addChildren(int index,
                        List<? extends N> children)

Description copied from interface: ParentNode

Adds the given children at the given index (shifting existing children if necessary).

Specified by:

addChildren in interface ParentNode<N extends SoyNode>

Parameters:

index - The index to add the children at.

children - The children to add.

appendSourceStringForChildren

public void appendSourceStringForChildren(StringBuilder sb)

Description copied from interface: ParentNode

Appends the source strings for all the children to the given StringBuilder.

Specified by:

appendSourceStringForChildren in interface ParentNode<N extends SoyNode>

Parameters:

sb - The StringBuilder to which to append the children's source strings.

getCommandName

public String getCommandName()

Description copied from interface: SoyNode.CommandNode

Returns the Soy command name.

Specified by:

getCommandName in interface SoyNode.CommandNode

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

protected final String getTagString(boolean selfEnding)