com.google.template.soy.soytree

Interface SoyNode.MsgSubstUnitNode

All Superinterfaces:

Node, SoyNode, SoyNode.StandaloneNode

All Known Implementing Classes:

MsgPlaceholderNode, MsgPluralNode, MsgSelectNode

Enclosing interface:

SoyNode

public static interface SoyNode.MsgSubstUnitNode
extends SoyNode.StandaloneNode

A substitution unit is any non-raw-text message part, since it will be replaced when the message is rendered. Currently, one of MsgPlaceholderNode, MsgSelectNode, or MsgPluralNode.

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	getBaseVarName() Returns the base var name for this substitution unit.
SoyNode.MsgBlockNode	getParent() Gets this node's parent.
boolean	shouldUseSameVarNameAs(SoyNode.MsgSubstUnitNode other) Returns whether this substitution unit should use the same var name as another substitution unit.

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

getParent

SoyNode.MsgBlockNode 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

Returns:

This node's parent.

getBaseVarName

String getBaseVarName()

Returns the base var name for this substitution unit. (For a placeholder, this is the base placeholder name.)

Note: This isn't quite correct semantically. It's conceivable that a new type of substitution unit in the future could have multiple vars. But until that happens, this simpler model is sufficient.

shouldUseSameVarNameAs

boolean shouldUseSameVarNameAs(SoyNode.MsgSubstUnitNode other)

Returns whether this substitution unit should use the same var name as another substitution unit. (For placeholders, this means the other placeholder is exactly the same as this one, i.e. it appears twice in the same message.)

Parameters:

other - The other substitution unit to check against.