org.apache.flex.compiler.tree.as

Interface IDefinitionNode

All Superinterfaces:

IASNode, ISourceLocation

All Known Subinterfaces:

IAccessorNode, IClassNode, ICommonClassNode, IDocumentableDefinitionNode, IEffectTagNode, IEventTagNode, IFunctionNode, IGetterNode, IInitializableDefinitionNode, IInterfaceNode, IMXMLApplicationNode, IMXMLClassDefinitionNode, IMXMLDocumentNode, IMXMLStateNode, INamespaceNode, IPackageNode, IParameterNode, IScopedDefinitionNode, ISetterNode, IStyleTagNode, ITypedNode, ITypeNode, IVariableNode

All Known Implementing Classes:

AccessorNode, BaseDefinitionMetaTagNode, BaseDefinitionNode, BaseTypedDefinitionNode, BaseVariableNode, ChainedVariableNode, ClassNode, ConfigConstNode, ConfigNamespaceNode, EffectTagNode, EventTagNode, FunctionNode, GetterNode, InterfaceNode, MemberedNode, MXMLClassDefinitionNode, MXMLDocumentNode, NamespaceNode, PackageNode, ParameterNode, SetterNode, StyleTagNode, VariableNode

public interface IDefinitionNode
extends IASNode

An AST node representing a declaration of a package, class, interface, function, parameter, variable, constant, or namespace.

Each IDefinitionNode produces an IDefinition.

Field Summary

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

UNKNOWN

Method Summary

Methods

Modifier and Type	Method and Description
String	getContainingFilePath() Get the file path in which this type is defined
IDefinition	getDefinition()
IMetaInfo[]	getMetaInfos() Get the IMetaInfos for all the metadat tags of this node.
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
IExpressionNode	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
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	isImplicit() Is this definition an implicit definition that doesn't actually appear in the source file?

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

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

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

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

Method Detail

getName

String getName()

Get the name of the type

Returns:

type name

getNameExpressionNode

IExpressionNode getNameExpressionNode()

Gets the expression that represents the name of this IDefinitionNode

Returns:

the IExpressionNode that represents the name of this type

getContainingFilePath

String getContainingFilePath()

Get the file path in which this type is defined

Returns:

file path

getNameStart

int getNameStart()

Get the local start offset of the name

Returns:

local start offset of the name

getNameEnd

int getNameEnd()

Get the local end offset of the name

Returns:

local end offset of the name

getNameAbsoluteStart

int getNameAbsoluteStart()

Get the absolute start offset of the name

Returns:

absolute start offset of the name

getNameAbsoluteEnd

int getNameAbsoluteEnd()

Get the absolute end offset of the name

Returns:

absolute end offset of the name

getPackageName

String getPackageName()

Get package name that applies to this node

Specified by:

getPackageName in interface IASNode

Returns:

String containing fully-qualified package name.

getQualifiedName

String getQualifiedName()

Get the qualified name of this type

Returns:

the fully qualified name of this type

getShortName

String getShortName()

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

Returns:

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

hasModifier

boolean hasModifier(ASModifier modifier)

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

Returns:

true if the modifier is included in the set

hasNamespace

boolean hasNamespace(String namespace)

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

Parameters:

namespace - the namespace to check for

Returns:

true if the namespace exists

getNamespace

String getNamespace()

Returns the namespace that this member belongs to

Returns:

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

isImplicit

boolean isImplicit()

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

getMetaTags

IMetaTagsNode getMetaTags()

Get the metadata tags of this node.

Returns:

the IMetaTagsNode or null

getMetaInfos

IMetaInfo[] getMetaInfos()

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

Returns:

An array of IMetaInfos. Never null.

getDefinition

IDefinition getDefinition()