org.apache.flex.compiler.tree.as

Interface ICommonClassNode

All Superinterfaces:

IASNode, IDefinitionNode, IDocumentableDefinitionNode, IScopedDefinitionNode, ISourceLocation, ITypeNode

All Known Subinterfaces:

IClassNode, IMXMLApplicationNode, IMXMLClassDefinitionNode, IMXMLDocumentNode

All Known Implementing Classes:

ClassNode, MXMLClassDefinitionNode, MXMLDocumentNode

public interface ICommonClassNode
extends ITypeNode, IDocumentableDefinitionNode

This interface contains the APIs that are available for both ActionScript and MXML class nodes.

IClassNode extends this with APIs specific to AS trees and IMXMLClassDefinitionNode extends this with APIs specific to MXML trees.

Field Summary

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

UNKNOWN

Method Summary

Methods

Modifier and Type	Method and Description
String	getBaseClassName() Returns the name of this class' base class, if it exists.
IClassDefinition.ClassClassification	getClassClassification() Returns the classification of this ActionScript class
IClassDefinition	getDefinition() Returns the class definition corresponding to this class node.
String[]	getImplementedInterfaces() Returns the names of any interfaces that this class declares it implements.
IMetaTag[]	getMetaTagsByName(String name) Retrieve all of the meta attributes (e.g.

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, getMetaTags, getName, getNameAbsoluteEnd, getNameAbsoluteStart, getNameEnd, getNameExpressionNode, getNamespace, getNameStart, getPackageName, getQualifiedName, getShortName, hasModifier, hasNamespace, isImplicit

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

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

getASDocComment, hasExplicitComment

Method Detail

getDefinition

IClassDefinition getDefinition()

Returns the class definition corresponding to this class node.

Specified by:

getDefinition in interface IDefinitionNode

getBaseClassName

String getBaseClassName()

Returns the name of this class' base class, if it exists.

Returns:

the name of the base class, or null

getImplementedInterfaces

String[] getImplementedInterfaces()

Returns the names of any interfaces that this class declares it implements. This does not walk up the inheritance chain.

Returns:

an array of interface names, or an empty array

getMetaTagsByName

IMetaTag[] getMetaTagsByName(String name)

Retrieve all of the meta attributes (e.g. [Event("")]) that match the given name in the metadata for this class. This does not walk up the inehritance chain.

Parameters:

name - name of meta attributes to search for (e.g. Event or IconFile)

Returns:

array of meta attributes matching that name (or empty array)

getClassClassification

IClassDefinition.ClassClassification getClassClassification()

Returns the classification of this ActionScript class

Returns:

the IClassDefinition.ClassClassification object