org.apache.flex.compiler.tree.as

Interface IClassNode

All Superinterfaces:

IASNode, ICommonClassNode, IDefinitionNode, IDocumentableDefinitionNode, IScopedDefinitionNode, ISourceLocation, ITypeNode

All Known Implementing Classes:

ClassNode

public interface IClassNode
extends ICommonClassNode

An AST node representing a class declaration.

The shape of this node is:

 IClassNode
   IMetaTagsNode            <-- getMetaTagsNode()
   INamespaceDecorationNode <-- getNamespaceNode()
   IKeywordNode             <-- getKeywordNode()
   IExpressionNode          <-- getNameExpressionNode()
   IKeywordNode             <-- getExtendsKeywordNode()
   IExpressionNode          <-- getBaseClassExpressionNode()
   IKeywordNode             <-- getImplementsKeywordNode()
   IContainerNode           <-- getInterfacesNode()
   IScopedNode              <-- getScopedNode()
 

For example,

 [Foo]
 [Bar]
 public class B extends A implements I1, I2
 {
     ...
 }
 

is represented as

 IClassNode
   IMetaTagsNode
     IMetaTagNode "Foo"
     IMetaTagNode "Bar"
   INamespaceDecorationNode "public"
   IKeywordNode "class"
   IIdentifierNode "B"
   IKeywordNode "extends"
   IIdentifierNode "A"
   IKeywordNode "implements"
     IContainerNode
       IIdentifierNode "I1"
       IIdentifierNode "I2"
   IScopedNode
     ...
 

If there is no metadata, the corresponding child node is not present.

If there is no namespace, the corresponding child node is not present.

If there is no extends clause, the two corresponding child nodes are not present.

If there is no implements clause, the two corresponding child nodes are not present.

If the class implements only one interface, there is still an IContainerNode containing the one node for the interface.

Field Summary

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

UNKNOWN

Method Summary

Methods

Modifier and Type	Method and Description
IDefinitionNode[]	getAllMemberNodes() Returns an array of IDefinitionNode objects that represent all the children of this class that are members.
IExpressionNode	getBaseClassExpressionNode()
IExpressionNode[]	getImplementedInterfaceNodes()
IMetaTagNode[]	getMetaTagNodesByName(String name) Retrieve all of the meta attributes (e.g.

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

getBaseClassName, getClassClassification, getDefinition, getImplementedInterfaces, getMetaTagsByName

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

getBaseClassExpressionNode

IExpressionNode getBaseClassExpressionNode()

getImplementedInterfaceNodes

IExpressionNode[] getImplementedInterfaceNodes()

getAllMemberNodes

IDefinitionNode[] getAllMemberNodes()

Returns an array of IDefinitionNode objects that represent all the children of this class that are members. These include functions, variables and namespaces

Returns:

an array of IDefinitionNode children, or an empty array

getMetaTagNodesByName

IMetaTagNode[] getMetaTagNodesByName(String name)

Retrieve all of the meta attributes (e.g. [Event("")]) that match the given name in the metadata for this class or any of its base classes

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)