com.google.template.soy.exprtree

Class StringNode

java.lang.Object

com.google.template.soy.basetree.AbstractNode

com.google.template.soy.exprtree.AbstractExprNode

com.google.template.soy.exprtree.StringNode

All Implemented Interfaces:

Node, ExprNode, ExprNode.ConstantNode, ExprNode.PrimitiveNode

public final class StringNode
extends AbstractExprNode

Node representing a string value.

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.exprtree.ExprNode

ExprNode.ConstantNode, ExprNode.Kind, ExprNode.OperatorNode, ExprNode.ParentExprNode, ExprNode.PrimitiveNode

Field Summary

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

SPACES

Constructor Summary

Constructors

Constructor and Description
StringNode(String value, SourceLocation sourceLocation)

Method Summary

Modifier and Type	Method and Description
StringNode	clone() Copies this node.
ExprNode.Kind	getKind() Gets this node's kind (corresponding to this node's specific type).
SoyType	getType() Gets the data type of this node.
String	getValue() Returns the string value.
String	toSourceString() Equivalent to toSourceString(false).
String	toSourceString(boolean escapeToAscii) Builds a Soy string literal for this string value (including the surrounding single quotes).

Methods inherited from class com.google.template.soy.exprtree.AbstractExprNode

getParent, getSourceLocation

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

couldHaveSyntaxVersionAtLeast, getNearestAncestor, getSyntaxVersionBound, hasAncestor, maybeSetSyntaxVersionBound, setParent, toString, 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.exprtree.ExprNode

getParent

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

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

Constructor Detail

StringNode

public StringNode(String value,
                  SourceLocation sourceLocation)

Parameters:

value - The string value.

sourceLocation - The node's source location.

Method Detail

getKind

public ExprNode.Kind getKind()

Description copied from interface: ExprNode

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

Returns:

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

getType

public SoyType getType()

Description copied from interface: ExprNode

Gets the data type of this node.

getValue

public String getValue()

Returns the string value.

toSourceString

public String toSourceString()

Equivalent to toSourceString(false). 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.

Returns:

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

toSourceString

public String toSourceString(boolean escapeToAscii)

Builds a Soy string literal for this string value (including the surrounding single quotes).

Parameters:

escapeToAscii - Whether to escape non-ASCII characters as Unicode hex escapes (backslash + 'u' + 4 hex digits).

Returns:

A Soy string literal for this string value (including the surrounding single quotes).

clone

public StringNode 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 ExprNode

Specified by:

clone in class AbstractExprNode

Returns:

A clone of this code.