com.google.template.soy.exprtree

Class ProtoInitNode

java.lang.Object

com.google.template.soy.basetree.AbstractNode

com.google.template.soy.exprtree.AbstractExprNode

com.google.template.soy.exprtree.AbstractParentExprNode

com.google.template.soy.exprtree.ProtoInitNode

All Implemented Interfaces:

Node, ParentNode<ExprNode>, ExprNode, ExprNode.ParentExprNode

public final class ProtoInitNode
extends AbstractParentExprNode

A node representing a proto initialization function (with args as children).

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

Nested Class Summary

Nested classes/interfaces inherited from interface com.google.template.soy.exprtree.ExprNode

ExprNode.Kind, ExprNode.OperatorNode, ExprNode.ParentExprNode, ExprNode.PrimitiveNode

Constructor Summary

Constructors

Constructor and Description
ProtoInitNode(String protoName, Iterable<String> paramNames, SourceLocation sourceLocation)

Method Summary

Modifier and Type	Method and Description
ProtoInitNode	copy(CopyState copyState) See Node.copy(CopyState) for a description of the copy contract.
ExprNode.Kind	getKind() Gets this node's kind (corresponding to this node's specific type).
String	getParamName(int i)
com.google.common.collect.ImmutableList<String>	getParamNames() Returns the list of proto initialization call param names.
String	getProtoName() Returns the name of the fully qualified proto.
String	toSourceString() Builds a Soy source string that could be the source for this node.

Methods inherited from class com.google.template.soy.exprtree.AbstractParentExprNode

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

Methods inherited from class com.google.template.soy.exprtree.AbstractExprNode

getParent, getSourceLocation

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

couldHaveSyntaxVersionAtLeast, equals, getNearestAncestor, getSyntaxVersionUpperBound, hasAncestor, hashCode, maybeSetSyntaxVersionUpperBound, setParent, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.template.soy.exprtree.ExprNode

getParent

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

couldHaveSyntaxVersionAtLeast, getNearestAncestor, getSourceLocation, getSyntaxVersionUpperBound, hasAncestor, maybeSetSyntaxVersionUpperBound, setParent

Constructor Detail

ProtoInitNode

public ProtoInitNode(String protoName,
                     Iterable<String> paramNames,
                     SourceLocation sourceLocation)

Parameters:

protoName - The fully qualified name of the proto.

paramNames - An iterable of proto initialization arg param names.

sourceLocation - The node's source location.

Method Detail

getKind

public ExprNode.Kind getKind()

Description copied from interface: ExprNode

Gets this node's kind (corresponding to this node's specific type).

Returns:

This node's kind (corresponding to this node's specific type).

getProtoName

public String getProtoName()

Returns the name of the fully qualified proto.

getParamNames

public com.google.common.collect.ImmutableList<String> getParamNames()

Returns the list of proto initialization call param names.

Each param name corresponds to each of this node's children, which are the param values.

getParamName

public String getParamName(int i)

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.

Returns:

A Soy string that could be the source for this node.

copy

public ProtoInitNode copy(CopyState copyState)

Description copied from interface: ExprNode

See Node.copy(CopyState) for a description of the copy contract.

Returns:

A clone of this code.