CallDelegateNode (Closure Templates)

java.lang.Object
- com.google.template.soy.basetree.AbstractNode
- - com.google.template.soy.soytree.AbstractSoyNode
  - - com.google.template.soy.soytree.CallNode
    - - com.google.template.soy.soytree.CallDelegateNode

All Implemented Interfaces:

Node, ParentNode<CallParamNode>, SoyNode, SoyNode.CommandNode, SoyNode.ExprHolderNode, SoyNode.MsgPlaceholderInitialNode, SoyNode.ParentSoyNode<CallParamNode>, SoyNode.SplitLevelTopNode<CallParamNode>, SoyNode.StandaloneNode, SoyNode.StatementNode
```
public final class CallDelegateNode
extends CallNode
```
Node representing a call to a delegate template.
Important: Do not use outside of Soy code (treat as superpackage-private).

Constructor Summary

Constructors
Constructor and Description
`CallDelegateNode(int id, SourceLocation location, String delCalleeName, List<CommandTagAttribute> attributes, ErrorReporter errorReporter)`

Method Summary

All Methods Instance Methods Concrete Methods
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.
`boolean`	`allowEmptyDefault()` Returns whether this delegate call defaults to empty string if there's no active impl.
`void`	`appendSourceStringForChildren(StringBuilder sb)` Appends the source strings for all the children to the given StringBuilder.
`void`	`clearChildren()` Clears the list of children.
`CallDelegateNode`	`copy(CopyState copyState)` Copies this node.
`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).
`String`	`getDelCalleeName()` Returns the name of the delegate template being called.
`ExprRootNode`	`getDelCalleeVariantExpr()` Returns the variant expression for the delegate being called, or null if it's a string.
`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).
`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.
`protected String`	`getTagString(boolean selfEnding)`
`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`	`setDelCalleeName(String delCalleeName)` Do not call this method outside the contextual autoescaper.
`void`	`setParamsToRuntimeCheck(com.google.common.collect.ImmutableMap<TemplateDelegateNode,com.google.common.collect.ImmutableList<TemplateParam>> paramsToRuntimeCheck)` Sets the params that require runtime type checking for each possible delegate target.

Methods inherited from class com.google.template.soy.soytree.CallNode
genBasePhName, genSamenessKey, getDataExpr, getEscapingDirectives, getIsPcData, getParent, getTagString, getUserSuppliedPhExample, getUserSuppliedPhName, isPassingAllData, isPassingData, setEscapingDirectives, setIsPcData, toSourceString

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
  - CallDelegateNode
```
public CallDelegateNode(int id,
                        SourceLocation location,
                        String delCalleeName,
                        List<CommandTagAttribute> attributes,
                        ErrorReporter errorReporter)
```
- Method Detail
  - getKind
```
public SoyNode.Kind getKind()
```
    Description copied from interface: SoyNode
    
    Returns this node's kind (corresponding to this node's specific type).
  - getDelCalleeName
```
public String getDelCalleeName()
```
    Returns the name of the delegate template being called.
  - setDelCalleeName
```
public void setDelCalleeName(String delCalleeName)
```
    Do not call this method outside the contextual autoescaper.
  - getDelCalleeVariantExpr
```
@Nullable
public ExprRootNode getDelCalleeVariantExpr()
```
    Returns the variant expression for the delegate being called, or null if it's a string.
  - setParamsToRuntimeCheck
```
public void setParamsToRuntimeCheck(com.google.common.collect.ImmutableMap<TemplateDelegateNode,com.google.common.collect.ImmutableList<TemplateParam>> paramsToRuntimeCheck)
```
    Sets the params that require runtime type checking for each possible delegate target.
  - getParamsToRuntimeCheck
```
public com.google.common.collect.ImmutableList<TemplateParam> getParamsToRuntimeCheck(TemplateNode callee)
```
    Description copied from class: CallNode
    
    Returns the subset of params of the callee that require runtime type checking when this node is being rendered.
    
    Specified by:
    
    getParamsToRuntimeCheck in class CallNode
  - allowEmptyDefault
```
public boolean allowEmptyDefault()
```
    Returns whether this delegate call defaults to empty string if there's no active impl.
  - 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
  - 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
    
    Overrides:
    
    getExprList in class CallNode
  - copy
```
public CallDelegateNode copy(CopyState copyState)
```
    Description copied from interface: Node
    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
    Returns:
    
    A clone of this code.
  - 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
  - getTagString
```
protected final String getTagString(boolean selfEnding)
```

Class CallDelegateNode

Constructor Summary

Method Summary

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

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

CallDelegateNode

Method Detail

getKind

getDelCalleeName

setDelCalleeName

getDelCalleeVariantExpr

setParamsToRuntimeCheck

getParamsToRuntimeCheck

allowEmptyDefault

getCommandText

getExprList

copy

numChildren

getChild

getChildIndex

getChildren

addChild

addChild

removeChild

removeChild

replaceChild

replaceChild

clearChildren

addChildren

addChildren

appendSourceStringForChildren

getCommandName

getTagString