org.apache.flex.compiler.definitions

Interface IFunctionDefinition

All Superinterfaces:

IDefinition, IDocumentableDefinition, IScopedDefinition

All Known Subinterfaces:

IAccessorDefinition, IGetterDefinition, ISetterDefinition

All Known Implementing Classes:

AccessorDefinition, FunctionDefinition, GetterDefinition, SetterDefinition, SyntheticBindableGetterDefinition, SyntheticBindableSetterDefinition

public interface IFunctionDefinition
extends IScopedDefinition

A definition representing a function declaration.

An IFunctionDefinitionIFunctionNode.

For example, the function declaration

public function f(i:int):int;

creates a function definition whose base name is "f", whose namespace reference is to the public namespace, and whose type reference is named "Function". It has an IReference named "int" representing its return type. It also owns one parameter definition named "i".

A function definition is contained within a file scope, a package scope, a class scope, an interface scope, or a function scope; it contains a function scope.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	IFunctionDefinition.FunctionClassification Function classifications (local, class member, interface member, and package member)

Method Summary

Methods

Modifier and Type	Method and Description
IFunctionDefinition.FunctionClassification	getFunctionClassification() Get the classification for this function (local, argument, class member, etc)
IFunctionNode	getFunctionNode() Returns the IFunctionNode from which this definition was created, if the definition came from the AST for a source file.
IParameterDefinition[]	getParameters() Get the parameters of this function as an array of IParameterDefinition elements
String	getReturnTypeAsDisplayString() Converts this definition's IReference for its return type to a human-readable String.
IReference	getReturnTypeReference() Gets a reference to the return type for this function.
boolean	hasRequiredParameters() Returns true if the function has required parameters.
boolean	inlineFunction() Can this function be inlined
boolean	isCastFunction() Is this a cast function?
boolean	isConstructor() Is this a constructor?
boolean	isImplementation(ICompilerProject project) Determines whether this function is an implementation of a function from an implements Interface
boolean	isInline() Is this function marked as inline?
boolean	overridesAncestor(ICompilerProject project) Is this function actually overriding a function in a base class
IFunctionDefinition	resolveImplementedFunction(ICompilerProject project) Finds the definition of the IFunctionDefinition that defines this function
IFunctionDefinition	resolveOverriddenFunction(ICompilerProject project) Finds the definition of the IFunctionDefinition that we are overriding
ITypeDefinition	resolveReturnType(ICompilerProject project) Resolve this function's return type in the given scope and find its definition

Methods inherited from interface org.apache.flex.compiler.definitions.IScopedDefinition

getContainedScope

Methods inherited from interface org.apache.flex.compiler.definitions.IDocumentableDefinition

getExplicitSourceComment, hasExplicitComment

Methods inherited from interface org.apache.flex.compiler.definitions.IDefinition

getAbsoluteEnd, getAbsoluteStart, getAllMetaTags, getAncestorOfType, getBaseName, getBindableEventNames, getColumn, getContainingFilePath, getContainingScope, getContainingSourceFilePath, getDeprecationInfo, getEnd, getLine, getMetaTagByName, getMetaTagsByName, getModifiers, getNameColumn, getNameEnd, getNameLine, getNamespaceReference, getNameStart, getNode, getPackageName, getParent, getQualifiedName, getSourcePath, getStart, getTypeAsDisplayString, getTypeReference, hasMetaTagByName, hasModifier, hasNamespace, isBindable, isBindableStyle, isContingent, isContingentNeeded, isDeprecated, isDynamic, isFinal, isGeneratedEmbedClass, isImplicit, isInProject, isInternal, isNative, isOverride, isPrivate, isProtected, isPublic, isStatic, resolveNamespace, resolveType

Method Detail

getFunctionClassification

IFunctionDefinition.FunctionClassification getFunctionClassification()

Get the classification for this function (local, argument, class member, etc)

Returns:

function classification

getParameters

IParameterDefinition[] getParameters()

Get the parameters of this function as an array of IParameterDefinition elements

Returns:

the parameters of this function

hasRequiredParameters

boolean hasRequiredParameters()

Returns true if the function has required parameters.

getReturnTypeReference

IReference getReturnTypeReference()

Gets a reference to the return type for this function.

For example, for the function private function f(i:int):String, this is a reference to the String class.

Returns:

An IReference to a class or interface.

resolveReturnType

ITypeDefinition resolveReturnType(ICompilerProject project)

Resolve this function's return type in the given scope and find its definition

Parameters:

project - the ICompilerProject in which to resolve references

Returns:

an ITypeDefinition representing this function's return type, or null

getReturnTypeAsDisplayString

String getReturnTypeAsDisplayString()

Converts this definition's IReference for its return type to a human-readable String.

If the definition does not have a return type reference, this method returns the empty string.

This method should only be used for displaying return types in problems, and not for making semantic decisions.

Note:

Returns:

The result of calling IReference.getDisplayString()() on the IReference representing this definition's return type.

isConstructor

boolean isConstructor()

Is this a constructor?

Returns:

true if the member is a constructor

isCastFunction

boolean isCastFunction()

Is this a cast function?

Returns:

true if the member is a cast function

isInline

boolean isInline()

Is this function marked as inline?

Returns:

true if the function is inline.

inlineFunction

boolean inlineFunction()

Can this function be inlined

Returns:

true if function can be inlined

overridesAncestor

boolean overridesAncestor(ICompilerProject project)

Is this function actually overriding a function in a base class

Returns:

true if overriding Note that for valid code, isOverride and overridesAncestor are the same, but overridesAncestor can return true even if the override keyword is missing. Conversely, isOverride can return true, even if there is no matching function in a parent interface

resolveOverriddenFunction

IFunctionDefinition resolveOverriddenFunction(ICompilerProject project)

Finds the definition of the IFunctionDefinition that we are overriding

Returns:

an IFunctionDefinition or null

isImplementation

boolean isImplementation(ICompilerProject project)

Determines whether this function is an implementation of a function from an implements Interface

Returns:

true if this is an implementation

resolveImplementedFunction

IFunctionDefinition resolveImplementedFunction(ICompilerProject project)

Finds the definition of the IFunctionDefinition that defines this function

Returns:

the parent IFunctionDefinition or null

getFunctionNode

IFunctionNode getFunctionNode()

Returns the IFunctionNode from which this definition was created, if the definition came from the AST for a source file.

This method may require the AST to be reloaded or regenerated and therefore may be slow.