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.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.Kind, ExprNode.OperatorNode, ExprNode.ParentExprNode, ExprNode.PrimitiveNode

Constructor Summary

Constructors

Constructor and Description
StringNode(String value, QuoteStyle quoteStyle, SourceLocation sourceLocation)

Method Summary

Modifier and Type	Method and Description
StringNode	copy(CopyState copyState) See Node.copy(CopyState) for a description of the copy contract.
ExprNode.Kind	getKind() Gets this node's kind (corresponding to this node's specific type).
StringType	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, equals, getNearestAncestor, getSyntaxVersionUpperBound, hasAncestor, hashCode, maybeSetSyntaxVersionUpperBound, setParent, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, 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, getSyntaxVersionUpperBound, hasAncestor, maybeSetSyntaxVersionUpperBound, setParent

Constructor Detail

StringNode

public StringNode(String value,
                  QuoteStyle quoteStyle,
                  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 StringType 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, 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.

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

copy

public StringNode copy(CopyState copyState)

Description copied from interface: ExprNode

See Node.copy(CopyState) for a description of the copy contract.

Returns:

A clone of this code.