com.google.template.soy.soytree

Class IfCondNode

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

com.google.template.soy.soytree.AbstractBlockCommandNode

com.google.template.soy.soytree.IfCondNode

All Implemented Interfaces:

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

public final class IfCondNode
extends AbstractBlockCommandNode
implements SoyNode.ConditionalBlockNode, SoyNode.ExprHolderNode

Node representing a block within an 'if' statement that has a conditional expression (i.e. either the 'if' block or an 'elseif' block).

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

Constructor and Description
IfCondNode(int id, String commandName, ExprUnion condition)
IfCondNode(int id, String commandName, String commandText)

Method Summary

Modifier and Type	Method and Description
IfCondNode	clone() Copies this node.
List<ExprUnion>	getAllExprUnions() Returns the list of expressions in this node.
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	getExprText() Returns the text of the conditional expression.
ExprUnion	getExprUnion() Returns the parsed expression.
SoyNode.Kind	getKind() Returns this node's kind (corresponding to this node's specific type).
String	toSourceString() Builds a Soy source string that could be the source for this node.

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, getTagString

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

getId, getParent, 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.soytree.SoyNode

getId, getParent, getSourceLocation, setId, setSourceLocation

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

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

couldHaveSyntaxVersionAtLeast, getNearestAncestor, getSyntaxVersionBound, hasAncestor, maybeSetSyntaxVersionBound, setParent, toTreeString

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

getTagString

Constructor Detail

IfCondNode

public IfCondNode(int id,
                  String commandName,
                  String commandText)

Parameters:

id - The id for this node.

commandName - The command name -- either 'if' or 'elseif'.

commandText - The command text.

IfCondNode

public IfCondNode(int id,
                  String commandName,
                  ExprUnion condition)

Parameters:

id - The id for this node.

commandName - The command name -- either 'if' or 'elseif'.

condition - Determines when the body is performed.

Method Detail

getKind

public SoyNode.Kind getKind()

Description copied from interface: SoyNode

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

Specified by:

getKind in interface SoyNode

getExprText

public String getExprText()

Returns the text of the conditional expression.

getExprUnion

public ExprUnion getExprUnion()

Returns the parsed expression.

getCommandName

public String getCommandName()

Description copied from class: AbstractCommandNode

May be overridden by subclasses to keep consistent with tree modifications.

Specified by:

getCommandName in interface SoyNode.CommandNode

Overrides:

getCommandName in class AbstractCommandNode

getCommandText

public String getCommandText()

Description copied from class: AbstractCommandNode

May be overridden by subclasses to keep consistent with tree modifications.

Specified by:

getCommandText in interface SoyNode.CommandNode

Overrides:

getCommandText in class AbstractCommandNode

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

Overrides:

toSourceString in class AbstractParentCommandNode<SoyNode.StandaloneNode>

Returns:

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

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

clone

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