com.google.template.soy.soytree

Interface SoyNode.MsgPlaceholderInitialNode

All Superinterfaces:

Node, SoyNode, SoyNode.StandaloneNode

All Known Implementing Classes:

CallBasicNode, CallDelegateNode, CallNode, MsgHtmlTagNode, PrintNode

Enclosing interface:

SoyNode

public static interface SoyNode.MsgPlaceholderInitialNode
extends SoyNode.StandaloneNode

A node that can be the initial content (i.e. initial child) of a MsgPlaceholderNode.

Nested Class Summary

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.MsgBlockNode, SoyNode.MsgPlaceholderInitialNode, SoyNode.MsgSubstUnitNode, SoyNode.ParentSoyNode<N extends SoyNode>, SoyNode.RenderUnitNode, SoyNode.SplitLevelTopNode<N extends SoyNode>, SoyNode.StandaloneNode, SoyNode.StatementNode

Method Summary

Modifier and Type	Method and Description
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.
String	getUserSuppliedPhExample() Gets the user-supplied placeholder example, or null if not supplied or not applicable.
String	getUserSuppliedPhName() Gets the user-supplied placeholder name, or null if not supplied or not applicable.

Methods inherited from interface com.google.template.soy.soytree.SoyNode.StandaloneNode

getParent

Methods inherited from interface com.google.template.soy.soytree.SoyNode

copy, getId, getKind, setId

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

couldHaveSyntaxVersionAtLeast, getNearestAncestor, getSourceLocation, getSyntaxVersionUpperBound, hasAncestor, maybeSetSyntaxVersionUpperBound, setParent, toSourceString

Method Detail

getUserSuppliedPhName

@Nullable
String getUserSuppliedPhName()

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

Returns:

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

getUserSuppliedPhExample

@Nullable
String getUserSuppliedPhExample()

Gets the user-supplied placeholder example, or null if not supplied or not applicable.

Returns:

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

genBasePhName

String genBasePhName()

Generates the base placeholder name for this node.

Returns:

The base placeholder name for this node.

genSamenessKey

Object genSamenessKey()

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

Returns:

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