com.google.template.soy.soytree

Class CallBasicNode

java.lang.Object

com.google.template.soy.basetree.AbstractNode

com.google.template.soy.soytree.AbstractSoyNode

com.google.template.soy.soytree.AbstractCommandNode

com.google.template.soy.soytree.AbstractParentCommandNode<CallParamNode>

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

Field Summary

Fields

Modifier and Type	Field and Description
static SoyError	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

Method Summary

Modifier and Type	Method and Description
CallBasicNode	clone() Copies this node.
String	getCalleeName() Returns the full name of the template being called, or null if not yet set.
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.
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

genBasePhName, genSamenessKey, getAllExprUnions, getDataExpr, getEscapingDirectiveNames, getParent, getTagString, getUserSuppliedPhName, isPassingAllData, isPassingData, parseDataAttributeHelper, setEscapingDirectiveNames, toSourceString

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

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

buildTagStringHelper, buildTagStringHelper, getCommandName, getCommandText

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

getId, getSourceLocation, setId, setSourceLocation, 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

Field Detail

MISSING_CALLEE_NAME

public static final SoyError MISSING_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.

clone

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