CaseOrDefaultNode (Closure Templates)

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

All Implemented Interfaces:

Node, ParentNode<SoyNode.StandaloneNode>, SoyNode, SoyNode.BlockCommandNode, SoyNode.BlockNode, SoyNode.CommandNode, SoyNode.ParentSoyNode<SoyNode.StandaloneNode>

Direct Known Subclasses:

MsgPluralCaseNode, MsgPluralDefaultNode, MsgSelectCaseNode, MsgSelectDefaultNode, SwitchCaseNode, SwitchDefaultNode
```
public abstract class CaseOrDefaultNode
extends AbstractSoyNode
```
Abstract node representing a 'case' or 'default' block in 'select', 'switch' or 'plural' statements.
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.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

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

Constructor Summary

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

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addChild(int index, N child)` Adds the given child at the given index (shifting existing children if necessary).
`void`	`addChild(N child)` Adds the given child.
`void`	`addChildren(int index, List<? extends N> children)` Adds the given children at the given index (shifting existing children if necessary).
`void`	`addChildren(List<? extends N> children)` Adds the given children.
`void`	`appendSourceStringForChildren(StringBuilder sb)` Appends the source strings for all the children to the given StringBuilder.
`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).
`void`	`clearChildren()` Clears the list of children.
`N`	`getChild(int index)` Gets the child at the given index.
`int`	`getChildIndex(N child)` Finds the index of the given child.
`List<N>`	`getChildren()` Gets the list of children.
`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.
`String`	`getTagString()` Builds a Soy tag string that could be the Soy tag for this node.
`int`	`numChildren()` Gets the number of children.
`void`	`removeChild(int index)` Removes the child at the given index.
`void`	`removeChild(N child)` Removes the given child.
`void`	`replaceChild(int index, N newChild)` Replaces the child at the given index with the given new child.
`void`	`replaceChild(N currChild, N newChild)` Replaces the given current child with the given new child.
`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, getParent, 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.CommandNode
getCommandName, getCommandText, getTagString

Methods inherited from interface com.google.template.soy.soytree.SoyNode
copy, getId, getKind, getParent, setId

Methods inherited from interface com.google.template.soy.basetree.ParentNode
addChild, addChild, addChildren, addChildren, appendSourceStringForChildren, clearChildren, getChild, getChildIndex, getChildren, numChildren, removeChild, removeChild, replaceChild, replaceChild

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

- Constructor Detail
  - CaseOrDefaultNode
```
public CaseOrDefaultNode(int id,
                 SourceLocation sourceLocation,
                 String commandName,
                 String commandText)
                  throws SoySyntaxException
```
    Parameters:
    id - The id for this node.
    sourceLocation - The node's source location.
    commandName - The name of the Soy command.
    commandText - The command text, or empty string if none.
    
    Throws:
    
    SoySyntaxException
  - CaseOrDefaultNode
```
protected CaseOrDefaultNode(CaseOrDefaultNode orig,
                 CopyState copyState)
```
    Copy constructor.
    
    Parameters:
    orig - The node to copy.
- Method Detail
  - 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.
  - numChildren
```
public int numChildren()
```
    Description copied from interface: ParentNode
    
    Gets the number of children.
    
    Specified by:
    
    numChildren in interface ParentNode<N extends SoyNode>
    
    Returns:
    The number of children.
  - getChild
```
public N getChild(int index)
```
    Description copied from interface: ParentNode
    
    Gets the child at the given index.
    
    Specified by:
    
    getChild in interface ParentNode<N extends SoyNode>
    
    Parameters:
    index - The index of the child to get.
    
    Returns:
    The child at the given index.
  - getChildIndex
```
public int getChildIndex(N child)
```
    Description copied from interface: ParentNode
    
    Finds the index of the given child.
    
    Specified by:
    
    getChildIndex in interface ParentNode<N extends SoyNode>
    
    Parameters:
    child - The child to find the index of.
    
    Returns:
    The index of the given child, or -1 if the given child is not a child of this node.
  - getChildren
```
public List<N> getChildren()
```
    Description copied from interface: ParentNode
    
    Gets the list of children. Note: The returned list may not be a copy. Please do not modify the list directly. Instead, use the other methods in this class that are intended for modifying children. Also, if you're iterating over the children list as you're modifying it, then you should first make a copy of the children list to iterate over, in order to avoid ConcurrentModificationException.
    
    Specified by:
    
    getChildren in interface ParentNode<N extends SoyNode>
    
    Returns:
    The list of children.
  - addChild
```
public void addChild(N child)
```
    Description copied from interface: ParentNode
    
    Adds the given child.
    
    Specified by:
    
    addChild in interface ParentNode<N extends SoyNode>
    
    Parameters:
    child - The child to add.
  - addChild
```
public void addChild(int index,
            N child)
```
    Description copied from interface: ParentNode
    
    Adds the given child at the given index (shifting existing children if necessary).
    
    Specified by:
    
    addChild in interface ParentNode<N extends SoyNode>
    
    Parameters:
    index - The index to add the child at.
    child - The child to add.
  - removeChild
```
public void removeChild(int index)
```
    Description copied from interface: ParentNode
    
    Removes the child at the given index.
    
    Specified by:
    
    removeChild in interface ParentNode<N extends SoyNode>
    
    Parameters:
    index - The index of the child to remove.
  - removeChild
```
public void removeChild(N child)
```
    Description copied from interface: ParentNode
    
    Removes the given child.
    
    Specified by:
    
    removeChild in interface ParentNode<N extends SoyNode>
    
    Parameters:
    child - The child to remove.
  - replaceChild
```
public void replaceChild(int index,
                N newChild)
```
    Description copied from interface: ParentNode
    
    Replaces the child at the given index with the given new child.
    
    Specified by:
    
    replaceChild in interface ParentNode<N extends SoyNode>
    
    Parameters:
    index - The index of the child to replace.
    newChild - The new child.
  - replaceChild
```
public void replaceChild(N currChild,
                N newChild)
```
    Description copied from interface: ParentNode
    
    Replaces the given current child with the given new child.
    
    Specified by:
    
    replaceChild in interface ParentNode<N extends SoyNode>
    
    Parameters:
    currChild - The current child to be replaced.
    newChild - The new child.
  - clearChildren
```
public void clearChildren()
```
    Description copied from interface: ParentNode
    
    Clears the list of children.
    
    Specified by:
    
    clearChildren in interface ParentNode<N extends SoyNode>
  - addChildren
```
public void addChildren(List<? extends N> children)
```
    Description copied from interface: ParentNode
    
    Adds the given children.
    
    Specified by:
    
    addChildren in interface ParentNode<N extends SoyNode>
    
    Parameters:
    children - The children to add.
  - addChildren
```
public void addChildren(int index,
               List<? extends N> children)
```
    Description copied from interface: ParentNode
    
    Adds the given children at the given index (shifting existing children if necessary).
    
    Specified by:
    
    addChildren in interface ParentNode<N extends SoyNode>
    
    Parameters:
    index - The index to add the children at.
    children - The children to add.
  - appendSourceStringForChildren
```
public void appendSourceStringForChildren(StringBuilder sb)
```
    Description copied from interface: ParentNode
    
    Appends the source strings for all the children to the given StringBuilder.
    
    Specified by:
    
    appendSourceStringForChildren in interface ParentNode<N extends SoyNode>
    
    Parameters:
    sb - The StringBuilder to which to append the children's source strings.
  - 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.

Class CaseOrDefaultNode

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

Methods inherited from interface com.google.template.soy.soytree.SoyNode

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

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

Constructor Detail

CaseOrDefaultNode

CaseOrDefaultNode

Method Detail

toSourceString

numChildren

getChild

getChildIndex

getChildren

addChild

addChild

removeChild

removeChild

replaceChild

replaceChild

clearChildren

addChildren

addChildren

appendSourceStringForChildren

getCommandName

getCommandText

getTagString

buildTagStringHelper

buildTagStringHelper