com.google.template.soy.soytree

Class MsgPluralNode

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

com.google.template.soy.soytree.MsgPluralNode

All Implemented Interfaces:

Node, ParentNode<CaseOrDefaultNode>, SoyNode, SoyNode.CommandNode, SoyNode.ExprHolderNode, SoyNode.MsgSubstUnitNode, SoyNode.ParentSoyNode<CaseOrDefaultNode>, SoyNode.SplitLevelTopNode<CaseOrDefaultNode>, SoyNode.StandaloneNode

public final class MsgPluralNode
extends AbstractParentCommandNode<CaseOrDefaultNode>
implements SoyNode.MsgSubstUnitNode, SoyNode.SplitLevelTopNode<CaseOrDefaultNode>, SoyNode.ExprHolderNode

Node representing a 'plural' block.

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MsgPluralNode.Builder Builder for MsgPluralNode.

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	FALLBACK_BASE_PLURAL_VAR_NAME Fallback base plural var name.

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

SPACES

Method Summary

Modifier and Type	Method and Description
MsgPluralNode	clone() Copies this node.
List<ExprUnion>	getAllExprUnions() Returns the list of expressions in this node.
String	getBaseVarName() Returns the base plural var name (what the translator sees).
ExprRootNode<?>	getExpr() Returns the parsed expression.
String	getExprText() Returns the expression text.
SoyNode.Kind	getKind() Returns this node's kind (corresponding to this node's specific type).
int	getOffset() Returns the offset.
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 class com.google.template.soy.soytree.AbstractParentCommandNode

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

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

buildTagStringHelper, buildTagStringHelper, getCommandName, getCommandText, getTagString

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

getId, getSourceLocation, setId, setSourceLocation

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

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

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

Field Detail

FALLBACK_BASE_PLURAL_VAR_NAME

public static final String FALLBACK_BASE_PLURAL_VAR_NAME

Fallback base plural var name.

See Also:

Constant Field Values

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

getOffset

public int getOffset()

Returns the offset.

getExprText

public String getExprText()

Returns the expression text.

getExpr

public ExprRootNode<?> getExpr()

Returns the parsed expression.

getBaseVarName

public String getBaseVarName()

Returns the base plural var name (what the translator sees).

Specified by:

getBaseVarName in interface SoyNode.MsgSubstUnitNode

shouldUseSameVarNameAs

public boolean shouldUseSameVarNameAs(SoyNode.MsgSubstUnitNode other)

Description copied from interface: SoyNode.MsgSubstUnitNode

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

Specified by:

shouldUseSameVarNameAs in interface SoyNode.MsgSubstUnitNode

Parameters:

other - The other substitution unit to check against.

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

getParent

public 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.MsgSubstUnitNode

Specified by:

getParent in interface SoyNode.StandaloneNode

Overrides:

getParent in class AbstractSoyNode

Returns:

This node's parent.

clone

public MsgPluralNode 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.