org.apache.flex.compiler.definitions

Interface IParameterDefinition

All Superinterfaces:

IDefinition, IDocumentableDefinition, IVariableDefinition

All Known Implementing Classes:

ParameterDefinition

public interface IParameterDefinition
extends IVariableDefinition

A definition representing a parameter declaration.

An IParameterDefinition is created from an IParameterNode.

For example, the function declaration

public function f(i:int):void;

creates one parameter definition whose base name is "i", whose namespace reference is to the public namespace, and whose type reference is named "int".

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.flex.compiler.definitions.IVariableDefinition

IVariableDefinition.VariableClassification

Method Summary

Methods

Modifier and Type	Method and Description
IParameterNode	getNode() Returns the IParameterNode from which this definition was created, if the definition came from the AST for a source file.
boolean	hasDefaultValue()
boolean	isRest() Returns true if this argument is a rest-style argument, signified by ...
Object	resolveDefaultValue(ICompilerProject project) Attempt to resolve the default value assigned to this parameter.

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

getArrayElementType, getInstanceType, getPercentProxy, getVariableClassification, getVariableNode, hasCollapseWhiteSpace, hasRichTextContent, isColor, isRequiredSkinPart, isSkinPart, resolveInitialValue

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, 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

isRest

boolean isRest()

Returns true if this argument is a rest-style argument, signified by ...

Returns:

true if we are a restful argument

hasDefaultValue

boolean hasDefaultValue()

resolveDefaultValue

Object resolveDefaultValue(ICompilerProject project)

Attempt to resolve the default value assigned to this parameter. This may cause the AST for the definition to get reloaded, so could be slow.

Parameters:

project - the Project to resolve things in

Returns:

The constant value of the default value, if one can be determined, or null if it can't be determined. This will be a String, int, double, boolean, or Namespace depending on what the initial value was. The value could also be org.apache.flex.abc.ABCConstants.UNDEFINED_VALUE if the initial value was the undefined constant value Callers will need to use instanceof to see what type the value is.

getNode

IParameterNode getNode()

Returns the IParameterNode 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.

Specified by:

getNode in interface IDefinition