CallParamNode (Closure Templates)

java.lang.Object
- com.google.template.soy.basetree.AbstractNode
- - com.google.template.soy.soytree.AbstractSoyNode
  - - com.google.template.soy.soytree.CallParamNode

All Implemented Interfaces:

Node, SoyNode, SoyNode.CommandNode

Direct Known Subclasses:

CallParamContentNode, CallParamValueNode
```
public abstract class CallParamNode
extends AbstractSoyNode
```
Abstract node representing a 'param'.
Important: Do not use outside of Soy code (treat as superpackage-private).

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

protected static class CallParamNode.CommandTextParseResult
Return value for parseCommandTextHelper().
- Nested classes/interfaces inherited from interface com.google.template.soy.soytree.SoyNode
  SoyNode.BlockCommandNode, SoyNode.BlockNode, SoyNode.CommandNode, SoyNode.ConditionalBlockNode, SoyNode.ExprHolderNode, SoyNode.Kind, SoyNode.LocalVarBlockNode, SoyNode.LocalVarInlineNode, SoyNode.LocalVarNode, SoyNode.LoopNode, SoyNode.MsgBlockNode, SoyNode.MsgPlaceholderInitialNode, SoyNode.MsgSubstUnitNode, SoyNode.ParentSoyNode<N extends SoyNode>, SoyNode.RenderUnitNode, SoyNode.SplitLevelTopNode<N extends SoyNode>, SoyNode.StandaloneNode, SoyNode.StatementNode

Nested Classes
Modifier and Type	Class and Description
`protected static class`	`CallParamNode.CommandTextParseResult` Return value for `parseCommandTextHelper()`.

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

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`CallParamNode(CallParamNode orig, CopyState copyState)` Copy constructor.
`protected`	`CallParamNode(int id, SourceLocation sourceLocation, String commandText)`

Method Summary

Methods
Modifier and Type	Method and Description
`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).
`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.
`abstract String`	`getKey()` Returns the param key.
`CallNode`	`getParent()` Gets this node's parent.
`String`	`getTagString()` Builds a Soy tag string that could be the Soy tag for this node.
`String`	`toSourceString()` Builds a Soy source string that could be the source for this node.

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.soytree.SoyNode
copy, getId, getKind, setId

Methods inherited from interface com.google.template.soy.basetree.Node
couldHaveSyntaxVersionAtLeast, getNearestAncestor, getSourceLocation, getSyntaxVersionUpperBound, hasAncestor, maybeSetSyntaxVersionUpperBound, setParent

- Constructor Detail
  - CallParamNode
```
protected CallParamNode(int id,
             SourceLocation sourceLocation,
             String commandText)
```
    Parameters:
    id - The id for this node.
    sourceLocation - The node's source location.
    commandText - The command text.
  - CallParamNode
```
protected CallParamNode(CallParamNode orig,
             CopyState copyState)
```
    Copy constructor.
    
    Parameters:
    orig - The node to copy.
- Method Detail
  - getKey
```
public abstract String getKey()
```
    Returns the param key.
  - getParent
```
public CallNode getParent()
```
    Description copied from interface: Node
    
    Gets this node's parent.
    
    Specified by:
    
    getParent in interface Node
    
    Specified by:
    
    getParent in interface SoyNode
    
    Overrides:
    
    getParent in class AbstractSoyNode
    
    Returns:
    This node's parent.
  - 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
  - getTagString
```
public String getTagString()
```
    Description copied from interface: SoyNode.CommandNode
    
    Builds a Soy tag string that could be the Soy tag for this node. Note that this may not necessarily be the actual original Soy tag, but a (sort of) canonical equivalent.
    
    Specified by:
    
    getTagString in interface SoyNode.CommandNode
    
    Returns:
    A Soy tag string that could be the Soy tag for this node.
  - 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.
  - 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.
    
    Specified by:
    
    toSourceString in interface Node
    
    Returns:
    A Soy string that could be the source for this node.

Class CallParamNode

Nested Class Summary

Nested classes/interfaces inherited from interface com.google.template.soy.soytree.SoyNode

Field Summary

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

Constructor Summary

Method Summary

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.soytree.SoyNode

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

Constructor Detail

CallParamNode

CallParamNode

Method Detail

getKey

getParent

getCommandName

getCommandText

getTagString

buildTagStringHelper

buildTagStringHelper

toSourceString