com.google.template.soy.exprtree

Class GlobalNode

java.lang.Object

com.google.template.soy.basetree.AbstractNode

com.google.template.soy.exprtree.AbstractExprNode

com.google.template.soy.exprtree.GlobalNode

All Implemented Interfaces:

Node, ExprNode

public final class GlobalNode
extends AbstractExprNode

Node representing a global.

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GlobalNode.ResolutionCallback Simple callback interface for hooking into globals resolution.

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
GlobalNode(String name, SourceLocation sourceLocation)

Method Summary

Modifier and Type	Method and Description
GlobalNode	copy(CopyState copyState) See Node.copy(CopyState) for a description of the copy contract.
static GlobalNode	error(SourceLocation location)
ExprNode.Kind	getKind() Gets this node's kind (corresponding to this node's specific type).
String	getName() Returns the name of the global.
SoyType	getType() Gets the data type of this node.
ExprNode.PrimitiveNode	getValue()
boolean	isResolved()
void	onResolve(GlobalNode.ResolutionCallback callback) Registers a callback that is invoked when this global is resolved to its actual value.
void	resolve(SoyType soyType, ExprNode.PrimitiveNode value)
boolean	shouldSuppressUnknownGlobalErrors() Returns true if 'unknown global' errors should not be reported for this node.
void	suppressUnknownGlobalErrors() Call this method to suppress unknown global errors for this node.
String	toSourceString() Builds a Soy source string that could be the source for this node.

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.basetree.Node

couldHaveSyntaxVersionAtLeast, getNearestAncestor, getSyntaxVersionUpperBound, hasAncestor, maybeSetSyntaxVersionUpperBound, setParent

Constructor Detail

GlobalNode

public GlobalNode(String name,
                  SourceLocation sourceLocation)

Parameters:

name - The name of the global.

sourceLocation - The node's source location.

Method Detail

error

public static GlobalNode error(SourceLocation location)

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 SoyType getType()

Description copied from interface: ExprNode

Gets the data type of this node.

resolve

public void resolve(SoyType soyType,
                    ExprNode.PrimitiveNode value)

onResolve

public void onResolve(GlobalNode.ResolutionCallback callback)

Registers a callback that is invoked when this global is resolved to its actual value.

NOTE: there is no guarantee that this will ever be called.

isResolved

public boolean isResolved()

getValue

public ExprNode.PrimitiveNode getValue()

getName

public String getName()

Returns the name of the global.

suppressUnknownGlobalErrors

public void suppressUnknownGlobalErrors()

Call this method to suppress unknown global errors for this node. This is appropriate if other errors have already been reported. TODO(lukes): consider upstreaming to Node. It may be useful for other kinds of errors.

shouldSuppressUnknownGlobalErrors

public boolean shouldSuppressUnknownGlobalErrors()

Returns true if 'unknown global' errors should not be reported 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, 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.

copy

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