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

Class PackageNode

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

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

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

All Implemented Interfaces:

ISourceLocation, IASNode, IDefinitionNode, IDocumentableDefinitionNode, IPackageNode, IScopedDefinitionNode

public class PackageNode
extends MemberedNode
implements IPackageNode

ActionScript parse tree node representing a package definition

Nested Class Summary

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

IPackageNode.PackageKind

Field Summary

Fields

Modifier and Type	Field and Description
protected int	packageKeywordStart Start offset for the package keyword
protected ExpressionNodeBase	packageNameNode The name of this package

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

contentsNode

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

definition, nameNode

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
PackageNode(ExpressionNodeBase packageNameNode, IASToken packageKeyword) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	analyze(EnumSet<PostProcessStep> set, ASScope scope, Collection<ICompilerProblem> problems)
protected boolean	buildInnerString(StringBuilder sb) For debugging only.
protected IDecorationPart	createDecorationPart()
PackageDefinition	getDefinition()
protected int	getInitialChildCount() Take a guess as to an efficient initial child count.
IMetaTagsNode	getMetaTags() Get the metadata tags of this node.
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
ExpressionNodeBase	getNameExpressionNode() Gets the expression that represents the name of this IDefinitionNode
String	getNamespace() Returns the namespace that this member belongs to
int	getNameStart() Get the local start offset of the name
ASTNodeID	getNodeID() Get the opcode of this node
int	getPackageKeywordEnd() Get the end offset for the package keyword
int	getPackageKeywordStart() Get the start offset for the package keyword
IPackageNode.PackageKind	getPackageKind() Returns the kind of package that this node represents
String	getPackageName() Get package name that applies to this node.
String	getQualifiedName() Get the qualified name of this type
String	getShortName() Get the short name of this type (without any package information)
boolean	hasModifier(ASModifier modifier) Is the given modifier present on this definition?
boolean	hasNamespace(String namespace) Is the given namespace present on this definition?
boolean	hasPackageKeyword() Determine whether or not this node has a package keyword
boolean	isImplicit() Is this definition an implicit definition that doesn't actually appear in the source file?
protected void	setChildren(boolean fillInOffsets) If this node has custom children (names, arguments, etc), shove them into the list of children.
void	setPackageName(ExpressionNodeBase packageNameNode) Sets the name of this package.

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

getAllMemberDefinitionNodes, getScopedNode

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

addDecorationChildren, addModifier, fillInMetadata, fillInModifiers, fillInNamespaceAndModifiers, getASDocComment, getDecorationPart, getMetaInfos, getMetaTagsNode, getModifiers, getModifiersContainer, getNamespaceNode, getNodeStartForTooling, getSpanningStart, hasExplicitComment, init, normalize, setASDocComment, setDefinition, setMetaTags, setModifiersContainer, setNamespace

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

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

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

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

getScopedNode

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

getContainingFilePath, getMetaInfos

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

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

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

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

Field Detail

packageKeywordStart

protected int packageKeywordStart

Start offset for the package keyword

packageNameNode

protected ExpressionNodeBase packageNameNode

The name of this package

Constructor Detail

PackageNode

public PackageNode(ExpressionNodeBase packageNameNode,
           IASToken packageKeyword)

Constructor.

Parameters:

packageNameNode - node holding this package name

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

getPackageName

public String getPackageName()

Description copied from interface: IASNode

Get package name that applies to this node. If this node doesn't reside inside a package definition, this method will return null.

Specified by:

getPackageName in interface IASNode

Specified by:

getPackageName in interface IDefinitionNode

Overrides:

getPackageName in class NodeBase

Returns:

String containing fully-qualified package name

setChildren

protected void setChildren(boolean fillInOffsets)

Description copied from class: NodeBase

If this node has custom children (names, arguments, etc), shove them into the list of children. Used during parsing.

Overrides:

setChildren in class NodeBase

analyze

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

Overrides:

analyze in class BaseDefinitionNode

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

getInitialChildCount

protected int getInitialChildCount()

Description copied from class: TreeNode

Take a guess as to an efficient initial child count. We can override this in nodes that have a fixed number of children.

Overrides:

getInitialChildCount in class TreeNode

Returns:

initial size to use when creating children

createDecorationPart

protected IDecorationPart createDecorationPart()

Overrides:

createDecorationPart in class BaseDefinitionNode

getMetaTags

public IMetaTagsNode getMetaTags()

Description copied from interface: IDefinitionNode

Get the metadata tags of this node.

Specified by:

getMetaTags in interface IDefinitionNode

Overrides:

getMetaTags in class BaseDefinitionNode

Returns:

the IMetaTagsNode or null

getNamespace

public String getNamespace()

Description copied from interface: IDefinitionNode

Returns the namespace that this member belongs to

Specified by:

getNamespace in interface IDefinitionNode

Overrides:

getNamespace in class BaseDefinitionNode

Returns:

public, private, protected, internal, custom namespace or 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

Overrides:

hasNamespace in class BaseDefinitionNode

Parameters:

namespace - the namespace to check for

Returns:

true if the namespace exists

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

Overrides:

hasModifier in class BaseDefinitionNode

Returns:

true if the modifier is included in the set

getNameExpressionNode

public ExpressionNodeBase getNameExpressionNode()

Description copied from interface: IDefinitionNode

Gets the expression that represents the name of this IDefinitionNode

Specified by:

getNameExpressionNode in interface IDefinitionNode

Overrides:

getNameExpressionNode in class BaseDefinitionNode

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

Overrides:

getName in class BaseDefinitionNode

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

Overrides:

getNameStart in class BaseDefinitionNode

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

Overrides:

getNameEnd in class BaseDefinitionNode

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

Overrides:

getNameAbsoluteStart in class BaseDefinitionNode

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

Overrides:

getNameAbsoluteEnd in class BaseDefinitionNode

Returns:

absolute end offset of the name

getDefinition

public PackageDefinition getDefinition()

Specified by:

getDefinition in interface IDefinitionNode

Overrides:

getDefinition in class BaseDefinitionNode

isImplicit

public boolean isImplicit()

Description copied from interface: IDefinitionNode

Is this definition an implicit definition that doesn't actually appear in the source file? Examples include this, super, default constructors, and cast functions.

Specified by:

isImplicit in interface IDefinitionNode

getQualifiedName

public String getQualifiedName()

Description copied from interface: IDefinitionNode

Get the qualified name of this type

Specified by:

getQualifiedName in interface IDefinitionNode

Returns:

the fully qualified name of this type

getShortName

public String getShortName()

Description copied from interface: IDefinitionNode

Get the short name of this type (without any package information)

Specified by:

getShortName in interface IDefinitionNode

Returns:

the short name of this type (without any package information)

getPackageKind

public IPackageNode.PackageKind getPackageKind()

Description copied from interface: IPackageNode

Returns the kind of package that this node represents

Specified by:

getPackageKind in interface IPackageNode

Returns:

a IPackageNode.PackageKind

setPackageName

public void setPackageName(ExpressionNodeBase packageNameNode)

Sets the name of this package. Should only be used during parsing.

Parameters:

packageNameNode - the name of the package

hasPackageKeyword

public boolean hasPackageKeyword()

Determine whether or not this node has a package keyword

Returns:

true if the node has a package keyword

getPackageKeywordStart

public int getPackageKeywordStart()

Get the start offset for the package keyword

Returns:

start offset for "package"

getPackageKeywordEnd

public int getPackageKeywordEnd()

Get the end offset for the package keyword

Returns:

end offset for "package"