com.google.template.soy.soytree

Class XidNode

java.lang.Object

com.google.template.soy.basetree.AbstractNode

com.google.template.soy.soytree.AbstractSoyNode

com.google.template.soy.soytree.XidNode

All Implemented Interfaces:

Node, SoyNode, SoyNode.CommandNode, SoyNode.StandaloneNode, SoyNode.StatementNode

public final class XidNode
extends AbstractSoyNode
implements SoyNode.StandaloneNode, SoyNode.StatementNode

Node representing an 'xid' statement.

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	XidNode.Builder Builder for XidNode.

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
XidNode(int id, SourceLocation sourceLocation, String commandText)

Method Summary

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).
XidNode	clone() Copies 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.
SoyNode.Kind	getKind() Returns this node's kind (corresponding to this node's specific type).
SoyNode.BlockNode	getParent() Gets this node's parent.
String	getRenamedText(SoyIdRenamingMap idRenamingMap)
String	getTagString() Builds a Soy tag string that could be the Soy tag for this node.
String	getText() Returns the text of the identifier.
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, getNearestAncestor, getSyntaxVersionBound, hasAncestor, maybeSetSyntaxVersionBound, setParent, toTreeString

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

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

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

Constructor Detail

XidNode

public XidNode(int id,
               SourceLocation sourceLocation,
               String commandText)

Parameters:

id - The id for this node.

commandText - The command text.

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

getText

public String getText()

Returns the text of the identifier.

getRenamedText

public String getRenamedText(SoyIdRenamingMap idRenamingMap)

getParent

public SoyNode.BlockNode getParent()

Description copied from interface: Node

Gets this node's parent.

Specified by:

getParent in interface Node

Specified by:

getParent in interface SoyNode

Specified by:

getParent in interface SoyNode.StandaloneNode

Overrides:

getParent in class AbstractSoyNode

Returns:

This node's parent.

clone

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

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