CallBasicNode (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.CallBasicNode

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 CallBasicNode
extends CallNode
```
Node representing a call to a basic template.
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 CallBasicNode.Builder
- Nested classes/interfaces inherited from class com.google.template.soy.soytree.CallNode
  CallNode.DataAttribute

Nested Classes
Modifier and Type	Class and Description
`static class`	`CallBasicNode.Builder`

Field Summary

Fields
Modifier and Type Field and Description

static SoyErrorKind BAD_CALLEE_NAME

static SoyErrorKind MISSING_CALLEE_NAME
- Fields inherited from class com.google.template.soy.soytree.CallNode
  FALLBACK_BASE_PLACEHOLDER_NAME
- Fields inherited from class com.google.template.soy.basetree.AbstractNode
  SPACES

Fields
Modifier and Type	Field and Description
`static SoyErrorKind`	`BAD_CALLEE_NAME`
`static SoyErrorKind`	`MISSING_CALLEE_NAME`

Method Summary

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.
`void`	`appendSourceStringForChildren(StringBuilder sb)` Appends the source strings for all the children to the given StringBuilder.
`protected String`	`buildTagStringHelper(boolean isSelfEnding)` Helper to build the source tag string (usually for testing/debugging).
`protected String`	`buildTagStringHelper(boolean isSelfEnding, boolean isImplicitCommandName)` Helper to build the source tag string (usually for testing/debugging).
`void`	`clearChildren()` Clears the list of children.
`CallBasicNode`	`copy(CopyState copyState)` Copies this node.
`String`	`getCalleeName()` Returns the full name of the template being called, or null if not yet set.
`N`	`getChild(int index)` Gets the child at the given index.
`int`	`getChildIndex(N child)` Finds the index of the given child.
`List<N>`	`getChildren()` Gets the list of children.
`String`	`getCommandName()` May be overridden by subclasses to keep consistent with tree modifications.
`String`	`getCommandText()` May be overridden by subclasses to keep consistent with tree modifications.
`SoyNode.Kind`	`getKind()` Returns this node's kind (corresponding to this node's specific type).
`Collection<TemplateParam>`	`getParamsToRuntimeCheck(TemplateNode callee)` Returns the subset of `params` of the `callee` that require runtime type checking when this node is being rendered.
`String`	`getSrcCalleeName()` Returns the callee name string as it appears in the source code.
`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`	`setCalleeName(String calleeName)` Sets the full name of the template being called (must not be a partial name).
`void`	`setParamsToRuntimeCheck(Collection<TemplateParam> paramNames)` Sets the names of the parameters that require runtime type checking against the callees formal types.

Methods inherited from class com.google.template.soy.soytree.CallNode
dataAttribute, genBasePhName, genSamenessKey, getAllExprUnions, getEscapingDirectiveNames, getParent, getTagString, getUserSuppliedPhName, parseDataAttributeHelper, setEscapingDirectiveNames, 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

- Field Detail
  - MISSING_CALLEE_NAME
```
public static final SoyErrorKind MISSING_CALLEE_NAME
```
  - BAD_CALLEE_NAME
```
public static final SoyErrorKind BAD_CALLEE_NAME
```
- Method Detail
  - getKind
```
public SoyNode.Kind getKind()
```
    Description copied from interface: SoyNode
    
    Returns this node's kind (corresponding to this node's specific type).
  - getSrcCalleeName
```
public String getSrcCalleeName()
```
    Returns the callee name string as it appears in the source code.
  - setCalleeName
```
public void setCalleeName(String calleeName)
```
    Sets the full name of the template being called (must not be a partial name).
    
    Parameters:
    calleeName - The full name of the template being called.
  - setParamsToRuntimeCheck
```
public void setParamsToRuntimeCheck(Collection<TemplateParam> paramNames)
```
    Sets the names of the parameters that require runtime type checking against the callees formal types.
  - getParamsToRuntimeCheck
```
public Collection<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.
    
    Overrides:
    
    getParamsToRuntimeCheck in class CallNode
  - getCalleeName
```
public String getCalleeName()
```
    Returns the full name of the template being called, or null if not yet set.
  - copy
```
public CallBasicNode 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(N 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()
```
    May be overridden by subclasses to keep consistent with tree modifications.
    
    Specified by:
    
    getCommandName in interface SoyNode.CommandNode
  - getCommandText
```
public String getCommandText()
```
    May be overridden by subclasses to keep consistent with tree modifications.
    
    Specified by:
    
    getCommandText in interface SoyNode.CommandNode
  - buildTagStringHelper
```
protected String buildTagStringHelper(boolean isSelfEnding)
```
    Helper to build the source tag string (usually for testing/debugging). Handles most cases, including (a) with or without tag text, (b) self-ending tags, or (c) tags whose text contains a brace character.
    
    Parameters:
    isSelfEnding - Whether the tag is self-ending, i.e. { ... /}.
    
    Returns:
    The source tag string, possibly with some differences in spacing.
  - buildTagStringHelper
```
protected String buildTagStringHelper(boolean isSelfEnding,
                          boolean isImplicitCommandName)
```
    Helper to build the source tag string (usually for testing/debugging). Handles all cases, including (a) with or without tag text, (b) self-ending tags, (c) tags whose text contains a brace character, or (d) implicit 'print' tags.
    
    Parameters:
    isSelfEnding - Whether the tag is self-ending, i.e. { ... /}.
    isImplicitCommandName - Whether the command name is implicit, e.g. a 'print' tag without the explicit 'print'.
    
    Returns:
    The source tag string, possibly with some differences in spacing.

Class CallBasicNode

Nested Class Summary

Nested classes/interfaces inherited from class com.google.template.soy.soytree.CallNode

Field Summary

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

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

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

Field Detail

MISSING_CALLEE_NAME

BAD_CALLEE_NAME

Method Detail

getKind

getSrcCalleeName

setCalleeName

setParamsToRuntimeCheck

getParamsToRuntimeCheck

getCalleeName

copy

numChildren

getChild

getChildIndex

getChildren

addChild

addChild

removeChild

removeChild

replaceChild

replaceChild

clearChildren

addChildren

addChildren

appendSourceStringForChildren

getCommandName

getCommandText

buildTagStringHelper

buildTagStringHelper