FunctionNode (Closure Templates)

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

All Implemented Interfaces:

Node, ParentNode<ExprNode>, ExprNode, ExprNode.ParentExprNode
```
public final class FunctionNode
extends AbstractParentExprNode
```
A node representing a 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.ConstantNode, ExprNode.Kind, ExprNode.OperatorNode, ExprNode.ParentExprNode, ExprNode.PrimitiveNode

Field Summary
- Fields inherited from class com.google.template.soy.basetree.AbstractNode
  SPACES

Constructor Summary

Constructors
Constructor and Description

FunctionNode(String functionName, SourceLocation sourceLocation)

Constructors
Constructor and Description
`FunctionNode(String functionName, SourceLocation sourceLocation)`

Method Summary

Methods
Modifier and Type	Method and Description
`FunctionNode`	`copy(CopyState copyState)` See `Node.copy(CopyState)` for a description of the copy contract.
`String`	`getFunctionName()` Returns the function name.
`ExprNode.Kind`	`getKind()` Gets this node's kind (corresponding to this node's specific type).
`SoyFunction`	`getSoyFunction()`
`void`	`setSoyFunction(SoyFunction soyFunction)`
`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
  - FunctionNode
```
public FunctionNode(String functionName,
            SourceLocation sourceLocation)
```
    Parameters:
    functionName - The function name.
    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).
  - getFunctionName
```
public String getFunctionName()
```
    Returns the function name.
  - getSoyFunction
```
@Nullable
public SoyFunction getSoyFunction()
```
  - setSoyFunction
```
public void setSoyFunction(SoyFunction soyFunction)
```
  - 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 FunctionNode 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.

Class FunctionNode

Nested Class Summary

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

Field Summary

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

Constructor Summary

Method Summary

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

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

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.exprtree.ExprNode

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

Constructor Detail

FunctionNode

Method Detail

getKind

getFunctionName

getSoyFunction

setSoyFunction

toSourceString

copy