com.adobe.flexbuilder.codemodel.definitions
Interface IDefinition

All Known Subinterfaces:

IArgument, IClass, IEffectTag, IEventTag, IFunction, IInterface, INamespace, IPackage, IStyleTag, IType, IVariable

public interface IDefinition

Interface for a definition node. Extended by IVariable, IPackage, IClass, IFunction

Method Summary

java.lang.String	getContainingFilePath() Get the file path in which this type is defined
java.lang.String	getContainingSourceFilePath() Get the source file path in which this type is defined.
IMetaTags	getMetaTags() Get the metadata tags of this node.
java.lang.String	getName() Get the name of the type
int	getNameEnd() Get the end offset of the name
java.lang.String	getNamespace() Returns the namespace that this member belongs to
int	getNameStart() Get the start offset of the name (useful for go to definition)
java.lang.String	getPackageName() Get package name that applies to this node
java.lang.String	getQualifiedName() Get the qualified name of this type
java.lang.String	getShortName() Get the short name of this type (without any package information)
boolean	hasModifier(java.lang.String modifier) Is the given modifier present on this definition? Modifiers include dynamic, explicit, final, native, override
boolean	hasNamespace(java.lang.String namespace) Is the given namespace present on this definition? Namespaces include private, protected, public and internal, plus any custom namespaces available in scope
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.
INamespace	resolveNamespace() Resolves the currently set namespace to its root definition.

Method Detail

getName

public java.lang.String getName()

Get the name of the type

Returns:

type name

getContainingFilePath

public java.lang.String getContainingFilePath()

Get the file path in which this type is defined

Returns:

file path

getContainingSourceFilePath

public java.lang.String getContainingSourceFilePath()

Get the source file path in which this type is defined. This will differ from getContainingFilePath() when the source came from a SWC, but there's an attached source folder.

Returns:

source file path

getNameStart

public int getNameStart()

Get the start offset of the name (useful for go to definition)

Returns:

start offset of the name

getNameEnd

public int getNameEnd()

Get the end offset of the name

Returns:

end offset of the name

getPackageName

public java.lang.String getPackageName()

Get package name that applies to this node

Returns:

String containing fully-qualified package name.

getQualifiedName

public java.lang.String getQualifiedName()

Get the qualified name of this type

Returns:

the fully qualified name of this type

getShortName

public java.lang.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

public boolean hasModifier(java.lang.String modifier)

Is the given modifier present on this definition? Modifiers include dynamic, explicit, final, native, override

Returns:

true iff the modifier is included in the set

hasNamespace

public boolean hasNamespace(java.lang.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 -

Returns:

true if the namespace exists

getNamespace

public java.lang.String getNamespace()

Returns the namespace that this member belongs to

Returns:

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

resolveNamespace

public INamespace resolveNamespace()

Resolves the currently set namespace to its root definition. Built-in namespaces will return null

Returns:

the INamespace or null

isImplicit

public 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

public IMetaTags getMetaTags()

Get the metadata tags of this node.

Returns:

The metadata tags