org.apache.flex.compiler.tree.as

Interface IInterfaceNode

All Superinterfaces:

IASNode, IDefinitionNode, IDocumentableDefinitionNode, IScopedDefinitionNode, ISourceLocation, ITypeNode

All Known Implementing Classes:

InterfaceNode

public interface IInterfaceNode
extends ITypeNode, IDocumentableDefinitionNode

An AST node representing a interface declaration.

The shape of this node is:

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

For example,

 [Foo]
 [Bar]
 public interface I extends I1, I2
 {
     ...
 }
 

is represented as

 IInterfaceNode
   IMetaTagsNode
     IMetaTagNode "Foo"
     IMetaTagNode "Bar"
   INamespaceDecorationNode "public"
   IKeywordNode "interface"
   IIdentifierNode "I"
   IKeywordNode "extends"
     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 the interface extends only one interface, there is still an IContainerNode containing the one node for the interface being extended.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	IInterfaceNode.InterfaceClassification Determines the type of interface

Field Summary

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

UNKNOWN

Method Summary

Methods

Modifier and Type	Method and Description
IDefinitionNode[]	getAllMemberDefinitionNodes() Returns an array of IDefinitionNode objects that represent all the children of this interface that are members.
IInterfaceDefinition	getDefinition() Gets the symbol that represents this IInterfaceNode
IExpressionNode[]	getExtendedInterfaceNodes() Returns the names of any interfaces that this IInterfaceNode directly references.
String[]	getExtendedInterfaces() Returns the names of any interfaces that this IInterfaceNode directly references.
IInterfaceNode.InterfaceClassification	getInterfaceClassification() Returns the classification of this ActionScript interface

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

getExtendedInterfaces

String[] getExtendedInterfaces()

Returns the names of any interfaces that this IInterfaceNode directly references. This does not walk up the inheritance chain, rather only looks at what is directly defined on the interface

Returns:

an array of interface names, or an empty array

getInterfaceClassification

IInterfaceNode.InterfaceClassification getInterfaceClassification()

Returns the classification of this ActionScript interface

Returns:

the IInterfaceNode.InterfaceClassification

getExtendedInterfaceNodes

IExpressionNode[] getExtendedInterfaceNodes()

Returns the names of any interfaces that this IInterfaceNode directly references. This does not walk up the inheritance chain, rather only looks at what is directly defined on the interface

Returns:

an array of interface names, or an empty array

getAllMemberDefinitionNodes

IDefinitionNode[] getAllMemberDefinitionNodes()

Returns an array of IDefinitionNode objects that represent all the children of this interface that are members.

Returns:

an array of IDefinitionNode children, or an empty array

getDefinition

IInterfaceDefinition getDefinition()

Gets the symbol that represents this IInterfaceNode

Specified by:

getDefinition in interface IDefinitionNode

Returns:

an IInterfaceDefinition that is the symbolic representation of this node