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.

• copy

  public XidNode copy(CopyState copyState)

  Description copied from interface: SoyNode
  Copies this node. The copy's parent pointer is set to null.

  All copy() 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 copy(CopyState copyState) {
          return new T(this, copyState);
        }
     

  • all non-leaf copy constructors should be protected

  TODO(lukes): The usecases for a copy method are few and far between. Making the AST nodes immutable (or at least unmodifiable) would be preferable to maintaining our copy() methods.

  Don't clone nodes unless you know what you're doing. The Soy AST is not actually a tree (it contains back edges from variables to their definitions), and naively copying nodes can result in pointers into stale ASTs

  The copied nodes will have the same ids as the original nodes. If you need to copy a subtree with new ids assigned to the copied nodes, use SoytreeUtils.cloneWithNewIds(T, com.google.template.soy.base.internal.IdGenerator).

  Specified by:

  copy in interface Node

  Specified by:

  copy in interface SoyNode

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