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

Class BaseDefinitionNode

java.lang.Object

org.apache.flex.compiler.common.SourceLocation

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

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

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

All Implemented Interfaces:

ISourceLocation, IASNode, IDefinitionNode, IDocumentableDefinitionNode

Direct Known Subclasses:

BaseTypedDefinitionNode, MemberedNode, NamespaceNode

public abstract class BaseDefinitionNode
extends TreeNode
implements IDocumentableDefinitionNode, IDefinitionNode

Field Summary

Fields

Modifier and Type	Field and Description
protected IDefinition	definition
protected ExpressionNodeBase	nameNode The name of the definition

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

Constructor and Description
BaseDefinitionNode() Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addDecorationChildren(boolean fillInOffsets)
void	addModifier(ModifierNode node)
protected void	analyze(EnumSet<PostProcessStep> set, ASScope scope, Collection<ICompilerProblem> problems)
protected IDecorationPart	createDecorationPart()
protected void	fillInMetadata(DefinitionBase definition)
protected void	fillInModifiers(DefinitionBase db)
protected void	fillInNamespaceAndModifiers(DefinitionBase db) Helper method to fill in namespace, and modifier info for a definition.
IASDocComment	getASDocComment() Returns the raw IASDocComment without any processing
protected IDecorationPart	getDecorationPart()
DefinitionBase	getDefinition()
IMetaInfo[]	getMetaInfos() Get the IMetaInfos for all the metadat tags of this node.
IMetaTagsNode	getMetaTags() Get the metadata tags of this node.
protected MetaTagsNode	getMetaTagsNode()
ModifiersSet	getModifiers() Get the modifiers of this variable.
ModifiersContainerNode	getModifiersContainer()
String	getName() Get the name of the type
int	getNameAbsoluteEnd() Get the absolute end offset of the name
int	getNameAbsoluteStart() Get the absolute start offset of the name
int	getNameEnd() Get the local end offset of the name
IExpressionNode	getNameExpressionNode() Gets the expression that represents the name of this IDefinitionNode
String	getNamespace() Returns the namespace that this member belongs to
INamespaceDecorationNode	getNamespaceNode()
int	getNameStart() Get the local start offset of the name
protected int	getNodeStartForTooling() returns the start of the first child node that is not ignored by the tooling.
int	getSpanningStart() Gets the local offset where the node starts, including any extra items that may change the appearance of the node's start.
boolean	hasExplicitComment() Determines if this node has an explicit comment.
boolean	hasModifier(ASModifier modifier) Is the given modifier present on this definition?
boolean	hasNamespace(String namespace) Is the given namespace present on this definition?
protected void	init(ExpressionNodeBase nameNode)
void	normalize(boolean fillInOffsets) Normalize the tree.
void	setASDocComment(IASDocComment ref)
protected void	setDefinition(IDefinition definition)
void	setMetaTags(MetaTagsNode tags) Set the metadata tags of the item.
void	setModifiersContainer(ModifiersContainerNode container)
void	setNamespace(INamespaceDecorationNode namespace)

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

addChild, addChild, addChildInOrder, addChildPostNormalize, addTemporaryChild, getChild, getChildCount, getInitialChildCount, optimizeChildren, removeAllChildren, removeChild, removeTemporaryChild, replaceChild, sortChildren, swapChildren

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

buildInnerString, buildStringRecursive, canContinueContainmentSearch, collectImportNodes, combineAttributes, connectedToProjectScope, contains, endAfter, endAfter, endBefore, endBefore, fillInOffsets, getAbsoluteEnd, getAbsoluteStart, getAncestorOfType, getASScope, getContainingFilePath, getContainingNode, getContainingScope, getEnd, getFileScope, getFileSpecification, getInnerString, getNodeKind, getPackageName, getParent, getScopeNode, getStart, getSucceedingNode, getWorkspace, isTerminal, isTransparent, looselyContains, runPostProcess, setChildren, setParent, span, span, span, startAfter, startAfter, startBefore, startBefore, 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.IDefinitionNode

getContainingFilePath, getPackageName, getQualifiedName, getShortName, isImplicit

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

contains, getAncestorOfType, getChild, getChildCount, getContainingNode, getContainingScope, getFileSpecification, getNodeID, getParent, getSucceedingNode, isTerminal

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

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

Field Detail

nameNode

protected ExpressionNodeBase nameNode

The name of the definition

definition

protected IDefinition definition

Constructor Detail

BaseDefinitionNode

public BaseDefinitionNode()

Constructor.

Method Detail

getSpanningStart

public int getSpanningStart()

Description copied from interface: IASNode

Gets the local offset where the node starts, including any extra items that may change the appearance of the node's start. These can include namespaces, keywords, modifiers, etc

Specified by:

getSpanningStart in interface IASNode

Overrides:

getSpanningStart in class NodeBase

Returns:

the start of the span

analyze

protected void analyze(EnumSet<PostProcessStep> set,
           ASScope scope,
           Collection<ICompilerProblem> problems)

Overrides:

analyze in class NodeBase

normalize

public void normalize(boolean fillInOffsets)

Description copied from class: NodeBase

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 TreeNode

hasExplicitComment

public boolean hasExplicitComment()

Description copied from interface: IDocumentableDefinitionNode

Determines if this node has an explicit comment. Since comments can inherit, the value from getComment might not always be defined on the element itself

Specified by:

hasExplicitComment in interface IDocumentableDefinitionNode

Returns:

true if we have an explicit comment

getMetaTags

public IMetaTagsNode getMetaTags()

Description copied from interface: IDefinitionNode

Get the metadata tags of this node.

Specified by:

getMetaTags in interface IDefinitionNode

Returns:

the IMetaTagsNode or null

getMetaInfos

public IMetaInfo[] getMetaInfos()

Description copied from interface: IDefinitionNode

Get the IMetaInfos for all the metadat tags of this node.

Specified by:

getMetaInfos in interface IDefinitionNode

Returns:

An array of IMetaInfos. Never null.

hasNamespace

public boolean hasNamespace(String namespace)

Description copied from interface: IDefinitionNode

Is the given namespace present on this definition? Namespaces include private, protected, public and internal, plus any custom namespaces available in scope

Specified by:

hasNamespace in interface IDefinitionNode

Parameters:

namespace - the namespace to check for

Returns:

true if the namespace exists

getNamespace

public String getNamespace()

Description copied from interface: IDefinitionNode

Returns the namespace that this member belongs to

Specified by:

getNamespace in interface IDefinitionNode

Returns:

public, private, protected, internal, custom namespace or null

hasModifier

public boolean hasModifier(ASModifier modifier)

Description copied from interface: IDefinitionNode

Is the given modifier present on this definition? see ASModifier for the list of modifiers

Specified by:

hasModifier in interface IDefinitionNode

Returns:

true if the modifier is included in the set

getNameExpressionNode

public IExpressionNode getNameExpressionNode()

Description copied from interface: IDefinitionNode

Gets the expression that represents the name of this IDefinitionNode

Specified by:

getNameExpressionNode in interface IDefinitionNode

Returns:

the IExpressionNode that represents the name of this type

getName

public String getName()

Description copied from interface: IDefinitionNode

Get the name of the type

Specified by:

getName in interface IDefinitionNode

Returns:

type name

getNameStart

public int getNameStart()

Description copied from interface: IDefinitionNode

Get the local start offset of the name

Specified by:

getNameStart in interface IDefinitionNode

Returns:

local start offset of the name

getNameEnd

public int getNameEnd()

Description copied from interface: IDefinitionNode

Get the local end offset of the name

Specified by:

getNameEnd in interface IDefinitionNode

Returns:

local end offset of the name

getNameAbsoluteStart

public int getNameAbsoluteStart()

Description copied from interface: IDefinitionNode

Get the absolute start offset of the name

Specified by:

getNameAbsoluteStart in interface IDefinitionNode

Returns:

absolute start offset of the name

getNameAbsoluteEnd

public int getNameAbsoluteEnd()

Description copied from interface: IDefinitionNode

Get the absolute end offset of the name

Specified by:

getNameAbsoluteEnd in interface IDefinitionNode

Returns:

absolute end offset of the name

getDefinition

public DefinitionBase getDefinition()

Specified by:

getDefinition in interface IDefinitionNode

init

protected void init(ExpressionNodeBase nameNode)

createDecorationPart

protected IDecorationPart createDecorationPart()

getDecorationPart

protected IDecorationPart getDecorationPart()

setMetaTags

public void setMetaTags(MetaTagsNode tags)

Set the metadata tags of the item.

Parameters:

tags - the current collection of IMetaTagNode tags

setNamespace

public void setNamespace(INamespaceDecorationNode namespace)

getNamespaceNode

public INamespaceDecorationNode getNamespaceNode()

getMetaTagsNode

protected MetaTagsNode getMetaTagsNode()

addModifier

public void addModifier(ModifierNode node)

setModifiersContainer

public void setModifiersContainer(ModifiersContainerNode container)

getModifiers

public ModifiersSet getModifiers()

Get the modifiers of this variable.

Returns:

modifiers node

getModifiersContainer

public ModifiersContainerNode getModifiersContainer()

getNodeStartForTooling

protected int getNodeStartForTooling()

returns the start of the first child node that is not ignored by the tooling. This is a replacement for getSpanningStart. Now getStart includes metadata and keywords, so getStart always includes that stuff. But in most cases the tooling does not want to count the metadata. TODO: consider removing getSpanningStart and all of the crazy overrides, and replace with this function

setASDocComment

public void setASDocComment(IASDocComment ref)

getASDocComment

public IASDocComment getASDocComment()

Returns the raw IASDocComment without any processing

Specified by:

getASDocComment in interface IDocumentableDefinitionNode

Returns:

an IASDocComment or null

addDecorationChildren

protected void addDecorationChildren(boolean fillInOffsets)

fillInNamespaceAndModifiers

protected void fillInNamespaceAndModifiers(DefinitionBase db)

Helper method to fill in namespace, and modifier info for a definition. This does not do any validation of the modifiers - the code calling this method still needs to make sure that the modifiers are appropriate for the specific definition type.

Parameters:

db -

fillInModifiers

protected void fillInModifiers(DefinitionBase db)

fillInMetadata

protected void fillInMetadata(DefinitionBase definition)

setDefinition

protected void setDefinition(IDefinition definition)