org.apache.flex.compiler.internal.tree.as

Class LiteralNode

java.lang.Object

org.apache.flex.compiler.common.SourceLocation

org.apache.flex.compiler.internal.tree.as.NodeBase

org.apache.flex.compiler.internal.tree.as.FixedChildrenNode

org.apache.flex.compiler.internal.tree.as.ExpressionNodeBase

org.apache.flex.compiler.internal.tree.as.LiteralNode

All Implemented Interfaces:

ISourceLocation, IASNode, IExpressionNode, ILiteralNode

Direct Known Subclasses:

NumericLiteralNode, RegExpLiteralNode

public class LiteralNode
extends ExpressionNodeBase
implements ILiteralNode

ActionScript parse tree node representing a literal (e.g. "blah" or true or 12)

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.flex.compiler.tree.as.ILiteralNode

ILiteralNode.LiteralType

Field Summary

Fields

Modifier and Type	Field and Description
protected ILiteralNode.LiteralType	type Type of the literal (e.g.
protected String	value

Fields inherited from class org.apache.flex.compiler.internal.tree.as.ExpressionNodeBase

flags

Fields inherited from class org.apache.flex.compiler.internal.tree.as.NodeBase

emptyNodeArray, parent

Fields inherited from interface org.apache.flex.compiler.common.ISourceLocation

UNKNOWN

Constructor Summary

Constructors

Modifier	Constructor and Description
	LiteralNode(ASToken t, ILiteralNode.LiteralType type) Constructor.
	LiteralNode(ILiteralNode.LiteralType type, String value) Constructor.
	LiteralNode(ILiteralNode.LiteralType type, String value, SourceLocation sourceLocation) Constructor.
	LiteralNode(ILiteralNode.LiteralType type, antlr.Token t) Constructor.
protected	LiteralNode(LiteralNode other) Copy constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected boolean	buildInnerString(StringBuilder sb) For debugging only.
protected LiteralNode	copy() Copy the ExpressionNodeBase and its subtree.
ILiteralNode.LiteralType	getLiteralType() Returns the ILiteralNode.LiteralType that this node represents
ASTNodeID	getNodeID() Get the opcode of this node
String	getValue() Returns the value of this literal as a String
String	getValue(boolean rawValue) Returns the value of this literal as a String
boolean	isDynamicExpression(ICompilerProject project) Does this expression evaluate to a dynamic value
boolean	isSynthetic() Returns whether this node is synthetic.
boolean	isTerminal() Determines if this node is a terminal node, meaning it cannot have children
void	normalize(boolean fillInOffsets) Normalize the tree.
ITypeDefinition	resolveType(ICompilerProject project) The type of the result of this expression.
void	setSynthetic(boolean synthetic) Sets whether this node is synthetic.

Methods inherited from class org.apache.flex.compiler.internal.tree.as.ExpressionNodeBase

computeNamespaceReference, copyForInitializer, getASScope, getBaseExpression, getDecorationNode, getDependencyType, getMName, getParentExpression, hasParenthesis, inFilter, inWith, isPackageReference, resolve, setHasParenthesis

Methods inherited from class org.apache.flex.compiler.internal.tree.as.NodeBase

analyze, buildStringRecursive, canContinueContainmentSearch, collectImportNodes, combineAttributes, connectedToProjectScope, contains, endAfter, endAfter, endBefore, endBefore, fillInOffsets, getAbsoluteEnd, getAbsoluteStart, getAncestorOfType, getChild, getChildCount, getContainingFilePath, getContainingNode, getContainingScope, getEnd, getFileScope, getFileSpecification, getInnerString, getNodeKind, getPackageName, getParent, getScopeNode, getSpanningStart, getStart, getSucceedingNode, getWorkspace, isTransparent, looselyContains, replaceChild, runPostProcess, setChildren, setParent, span, span, span, startAfter, startAfter, startBefore, startBefore, swapChildren, toString, tryGetOffsetLookup, verify

Methods inherited from class org.apache.flex.compiler.common.SourceLocation

getColumn, getEndColumn, getEndLine, getLine, getLineColumnString, getOffsetsString, getSourcePath, getSourcePathString, setColumn, setEnd, setEndColumn, setEndLine, setLine, setSourceLocation, setSourcePath, setStart, span, span

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.flex.compiler.tree.as.IExpressionNode

copyForInitializer, hasParenthesis, resolve

Methods inherited from interface org.apache.flex.compiler.tree.as.IASNode

contains, getAncestorOfType, getChild, getChildCount, getContainingNode, getContainingScope, getFileSpecification, getPackageName, getParent, getSpanningStart, getSucceedingNode

Methods inherited from interface org.apache.flex.compiler.common.ISourceLocation

getAbsoluteEnd, getAbsoluteStart, getColumn, getEnd, getEndColumn, getEndLine, getLine, getSourcePath, getStart

Field Detail

type

protected ILiteralNode.LiteralType type

Type of the literal (e.g. Boolean or String)

value

protected String value

Constructor Detail

LiteralNode

public LiteralNode(ILiteralNode.LiteralType type,
           String value)

Constructor.

Parameters:

type - The type of the literal.

value - The value of the literal.

LiteralNode

public LiteralNode(ILiteralNode.LiteralType type,
           antlr.Token t)

Constructor.

Parameters:

type - type of the literal

t - token

LiteralNode

public LiteralNode(ILiteralNode.LiteralType type,
           String value,
           SourceLocation sourceLocation)

Constructor.

Parameters:

type - type of the literal

value - value of the literal

sourceLocation - object that stores location information of the literal

LiteralNode

public LiteralNode(ASToken t,
           ILiteralNode.LiteralType type)

Constructor.

Parameters:

t - Token with text and source location.

type - Literal type

LiteralNode

protected LiteralNode(LiteralNode other)

Copy constructor.

Parameters:

other - The node to copy.

Method Detail

getNodeID

public ASTNodeID getNodeID()

Description copied from interface: IASNode

Get the opcode of this node

Specified by:

getNodeID in interface IASNode

Returns:

the opcode - this is one of the constants defined in ASTConstants

normalize

public void normalize(boolean fillInOffsets)

Description copied from class: ExpressionNodeBase

Normalize the tree. Move custom children into the real child list and fill in missing offsets so that offset lookup will work. Used during parsing.

Overrides:

normalize in class ExpressionNodeBase

buildInnerString

protected boolean buildInnerString(StringBuilder sb)

Description copied from class: NodeBase

For debugging only. This method is called by buildOuterString(). It is overridden by subclasses to display optional node-specific information in the middle of the string, between the node type and the location information.

Overrides:

buildInnerString in class NodeBase

isTerminal

public boolean isTerminal()

Description copied from interface: IASNode

Determines if this node is a terminal node, meaning it cannot have children

Specified by:

isTerminal in interface IASNode

Overrides:

isTerminal in class FixedChildrenNode

Returns:

true if this node is terminal

resolveType

public ITypeDefinition resolveType(ICompilerProject project)

Description copied from interface: IExpressionNode

The type of the result of this expression. This method returns the IDefinition representing the type that is the result of this expression. This can differ from the IDefinition you get from resolve(), such as when called on a FunctionCallNode: resolve() will return the IDefinition for the Function, whereas resolveType() will return the return type of the Function.

Specified by:

resolveType in interface IExpressionNode

Overrides:

resolveType in class ExpressionNodeBase

Parameters:

project - The ICompilerProject to use to do lookups.

Returns:

The ITypeDefinition of the type this expression results in.

copy

protected LiteralNode copy()

Description copied from class: ExpressionNodeBase

Copy the ExpressionNodeBase and its subtree.

Specified by:

copy in class ExpressionNodeBase

Returns:

a new ExpressionNodeBase that represents the same content as the original node

isDynamicExpression

public boolean isDynamicExpression(ICompilerProject project)

Description copied from interface: IExpressionNode

Does this expression evaluate to a dynamic value

Specified by:

isDynamicExpression in interface IExpressionNode

Overrides:

isDynamicExpression in class ExpressionNodeBase

Parameters:

project - The ICompilerProject to use to do lookups.

Returns:

true if we evaluate to something dynamic

getLiteralType

public ILiteralNode.LiteralType getLiteralType()

Description copied from interface: ILiteralNode

Returns the ILiteralNode.LiteralType that this node represents

Specified by:

getLiteralType in interface ILiteralNode

getValue

public String getValue()

Description copied from interface: ILiteralNode

Returns the value of this literal as a String

Specified by:

getValue in interface ILiteralNode

Returns:

the value of this literal as a String

getValue

public String getValue(boolean rawValue)

Description copied from interface: ILiteralNode

Returns the value of this literal as a String

Specified by:

getValue in interface ILiteralNode

Parameters:

rawValue - True if you want the raw value, otherwise some massaging of the value will be done before returning the value if it's a String (enclosing quotes will be removed).

Returns:

the value of this literal as a String

isSynthetic

public boolean isSynthetic()

Returns whether this node is synthetic. A synthetic node is one that is generated by the parser during parsing, and does not exist in source.

Returns:

true if synthetic

setSynthetic

public void setSynthetic(boolean synthetic)

Sets whether this node is synthetic. A synthetic node is one that is generated by the parser during parsing, and does not exist in source. A common synthetic literal node would be the result of the evaluation of a config expression

Parameters:

synthetic - true if this node is synthetic