com.google.template.soy.soytree

Class PrintNode

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

com.google.template.soy.soytree.PrintNode

All Implemented Interfaces:

Node, ParentNode<PrintDirectiveNode>, SoyNode, SoyNode.CommandNode, SoyNode.ExprHolderNode, SoyNode.MsgPlaceholderInitialNode, SoyNode.ParentSoyNode<PrintDirectiveNode>, SoyNode.SplitLevelTopNode<PrintDirectiveNode>, SoyNode.StandaloneNode, SoyNode.StatementNode

public final class PrintNode
extends AbstractParentCommandNode<PrintDirectiveNode>
implements SoyNode.StandaloneNode, SoyNode.SplitLevelTopNode<PrintDirectiveNode>, SoyNode.StatementNode, SoyNode.ExprHolderNode, SoyNode.MsgPlaceholderInitialNode

Node representing a 'print' statement.

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	FALLBACK_BASE_PLACEHOLDER_NAME Fallback base placeholder name.

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

SPACES

Constructor Summary

Constructors

Constructor and Description
PrintNode(int id, boolean isImplicit, ExprUnion exprUnion, String userSuppliedPlaceholderName) Constructor for use by passes that want to create a PrintNode with already-parsed expression.
PrintNode(int id, boolean isImplicit, String exprText, String userSuppliedPlaceholderName)

Method Summary

Modifier and Type	Method and Description
PrintNode	clone() Copies this node.
String	genBasePhName() Generates the base placeholder name for this node.
Object	genSamenessKey() Generates the key object used in comparisons to determine whether two placeholder nodes should be represented by the same placeholder.
List<ExprUnion>	getAllExprUnions() Returns the list of expressions in this node.
String	getCommandText() May be overridden by subclasses to keep consistent with tree modifications.
String	getExprText() Returns the text of the expression to print.
ExprUnion	getExprUnion() Returns the parsed expression, or null if the expression is not in V2 syntax.
SoyNode.Kind	getKind() Returns this node's kind (corresponding to this node's specific type).
SoyNode.BlockNode	getParent() Gets this node's parent.
String	getTagString() Builds a Soy tag string that could be the Soy tag for this node.
String	getUserSuppliedPhName() Gets the user-supplied placeholder name, or null if not supplied or not applicable.
boolean	isImplicit() Returns whether the 'print' command name was implicit.
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, getCommandName

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

getId, 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.basetree.ParentNode

addChild, addChild, addChildren, addChildren, appendSourceStringForChildren, appendTreeStringForChildren, clearChildren, getChild, getChildIndex, getChildren, numChildren, removeChild, removeChild, replaceChild, replaceChild

Field Detail

FALLBACK_BASE_PLACEHOLDER_NAME

public static final String FALLBACK_BASE_PLACEHOLDER_NAME

Fallback base placeholder name.

See Also:

Constant Field Values

Constructor Detail

PrintNode

public PrintNode(int id,
                 boolean isImplicit,
                 String exprText,
                 @Nullable
                 String userSuppliedPlaceholderName)
          throws SoySyntaxException

Parameters:

id - The id for this node.

isImplicit - Whether the command 'print' is implicit.

exprText - The text of the expression to print.

userSuppliedPlaceholderName - The user-supplied placeholder name, or null if not supplied or not applicable.

Throws:

SoySyntaxException - If a syntax error is found.

PrintNode

public PrintNode(int id,
                 boolean isImplicit,
                 ExprUnion exprUnion,
                 @Nullable
                 String userSuppliedPlaceholderName)

Constructor for use by passes that want to create a PrintNode with already-parsed expression.

Parameters:

id - The id for this node.

isImplicit - Whether the command 'print' is implicit.

exprUnion - The parsed expression.

userSuppliedPlaceholderName - The user-supplied placeholder name, or null if not supplied or not applicable.

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

isImplicit

public boolean isImplicit()

Returns whether the 'print' command name was implicit.

getExprText

public String getExprText()

Returns the text of the expression to print.

getExprUnion

public ExprUnion getExprUnion()

Returns the parsed expression, or null if the expression is not in V2 syntax.

getUserSuppliedPhName

public String getUserSuppliedPhName()

Description copied from interface: SoyNode.MsgPlaceholderInitialNode

Gets the user-supplied placeholder name, or null if not supplied or not applicable. Note that this raw name can be any identifier (not necessarily in upper-underscore format).

Specified by:

getUserSuppliedPhName in interface SoyNode.MsgPlaceholderInitialNode

Returns:

The user-supplied placeholder name, or null if not supplied or not applicable.

genBasePhName

public String genBasePhName()

Description copied from interface: SoyNode.MsgPlaceholderInitialNode

Generates the base placeholder name for this node.

Specified by:

genBasePhName in interface SoyNode.MsgPlaceholderInitialNode

Returns:

The base placeholder name for this node.

genSamenessKey

public Object genSamenessKey()

Description copied from interface: SoyNode.MsgPlaceholderInitialNode

Generates the key object used in comparisons to determine whether two placeholder nodes should be represented by the same placeholder.

Specified by:

genSamenessKey in interface SoyNode.MsgPlaceholderInitialNode

Returns:

The key object for determining whether this node and another node should be represented by the same placeholder.

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

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

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

Overrides:

getTagString in class AbstractCommandNode

Returns:

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

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

Returns:

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

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