com.google.template.soy.soytree

Class CallDelegateNode

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CallDelegateNode.Builder

Field Summary

Fields

Modifier and Type	Field and Description
static SoyError	INVALID_DELEGATE_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
boolean	allowsEmptyDefault() Returns whether this delegate call defaults to empty string if there's no active impl.
CallDelegateNode	clone() Copies this node.
List<ExprUnion>	getAllExprUnions() Returns the list of expressions in this node.
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.
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.
void	maybeSetAllowsEmptyDefault(boolean defaultValueForAllowsEmptyDefault) Sets allowsEmptyDefault to the given default value if it wasn't already user-specified.
void	setParamsToRuntimeCheck(com.google.common.collect.ImmutableMap<TemplateDelegateNode,com.google.common.collect.ImmutableList<TemplateParam>> paramsToRuntimeCheck) Sets the template params that require runtime type checking for each possible delegate target.

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

genBasePhName, genSamenessKey, 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

INVALID_DELEGATE_NAME

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

getDelCalleeName

public String getDelCalleeName()

Returns the name of the delegate template being called.

getDelCalleeVariantExpr

@Nullable
public ExprRootNode<?> getDelCalleeVariantExpr()

Returns the variant expression for the delegate being called, or null if it's a string.

maybeSetAllowsEmptyDefault

public void maybeSetAllowsEmptyDefault(boolean defaultValueForAllowsEmptyDefault)

Sets allowsEmptyDefault to the given default value if it wasn't already user-specified.

setParamsToRuntimeCheck

public void setParamsToRuntimeCheck(com.google.common.collect.ImmutableMap<TemplateDelegateNode,com.google.common.collect.ImmutableList<TemplateParam>> paramsToRuntimeCheck)

Sets the template params that require runtime type checking for each possible delegate target.

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

allowsEmptyDefault

public boolean allowsEmptyDefault()

Returns whether this delegate call defaults to empty string if there's no active impl.

getAllExprUnions

public List<ExprUnion> getAllExprUnions()

Description copied from interface: SoyNode.ExprHolderNode

Returns the list of expressions in this node.

Specified by:

getAllExprUnions in interface SoyNode.ExprHolderNode

Overrides:

getAllExprUnions in class CallNode

clone

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