org.apache.flex.compiler.internal.tree.as

Class InterfaceNode

java.lang.Object

org.apache.flex.compiler.common.SourceLocation

org.apache.flex.compiler.internal.tree.as.NodeBase

org.apache.flex.compiler.internal.tree.as.TreeNode

org.apache.flex.compiler.internal.tree.as.BaseDefinitionNode

org.apache.flex.compiler.internal.tree.as.MemberedNode

org.apache.flex.compiler.internal.tree.as.InterfaceNode

All Implemented Interfaces:

ISourceLocation, IASNode, IDefinitionNode, IDocumentableDefinitionNode, IInterfaceNode, IScopedDefinitionNode, ITypeNode

public class InterfaceNode
extends MemberedNode
implements IInterfaceNode

ActionScript parse tree node representing an interface definition

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.flex.compiler.tree.as.IInterfaceNode

IInterfaceNode.InterfaceClassification

Field Summary

Fields

Modifier and Type	Field and Description
protected TransparentContainerNode	baseInterfacesNode The collection of base interfaces
protected FunctionNode	castFunctionNode Generated FunctionNode to represent cast function
protected KeywordNode	extendsKeywordNode The extends keyword (if one is present)
protected KeywordNode	interfaceKeywordNode The class keyword

Fields inherited from class org.apache.flex.compiler.internal.tree.as.MemberedNode

contentsNode

Fields inherited from class org.apache.flex.compiler.internal.tree.as.BaseDefinitionNode

definition, nameNode

Fields inherited from class org.apache.flex.compiler.internal.tree.as.NodeBase

emptyNodeArray, parent

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

UNKNOWN

Constructor Summary

Constructors

Constructor and Description
InterfaceNode(ExpressionNodeBase name) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	addBaseInterface(ExpressionNodeBase interfaceName) Add an implemented interface to this class.
protected void	analyze(EnumSet<PostProcessStep> set, ASScope scope, Collection<ICompilerProblem> problems)
protected boolean	buildInnerString(StringBuilder sb) For debugging only.
ContainerNode	getBaseInterfacesNode() Get the container of base interfaces for this interfaces
FunctionNode	getCastFunctionNode() Get the dummy node representing the cast function
KeywordNode	getClassKeywordNode() Get the node containing the class keyword
InterfaceDefinition	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.
KeywordNode	getExtendsKeywordNode() Get the node containing the extends keyword, if one exists
protected int	getInitialChildCount() Take a guess as to an efficient initial child count.
IInterfaceNode.InterfaceClassification	getInterfaceClassification() Returns the classification of this ActionScript interface
ASTNodeID	getNodeID() Get the opcode of this node
String	getQualifiedName() Get the qualified name of this type
String	getShortName() Get the short name of this type (without any package information)
int	getSpanningStart() Gets the local offset where the node starts, including any extra items that may change the appearance of the node's start.
boolean	hasModifier(ASModifier modifier) Is the given modifier present on this definition?
protected void	init(ExpressionNodeBase nameNode)
boolean	isImplicit() Is this definition an implicit definition that doesn't actually appear in the source file?
protected void	setChildren(boolean fillInOffsets) If this node has custom children (names, arguments, etc), shove them into the list of children.
protected void	setDefinition(IDefinition definition)
void	setExtendsKeyword(IASToken extendsKeyword) Sets the extends keyword if one is present.
void	setInterfaceKeyword(IASToken interfaceKeyword) Sets the interface keyword.

Methods inherited from class org.apache.flex.compiler.internal.tree.as.MemberedNode

getAllMemberDefinitionNodes, getScopedNode

Methods inherited from class org.apache.flex.compiler.internal.tree.as.BaseDefinitionNode

addDecorationChildren, addModifier, createDecorationPart, fillInMetadata, fillInModifiers, fillInNamespaceAndModifiers, getASDocComment, getDecorationPart, getMetaInfos, getMetaTags, getMetaTagsNode, getModifiers, getModifiersContainer, getName, getNameAbsoluteEnd, getNameAbsoluteStart, getNameEnd, getNameExpressionNode, getNamespace, getNamespaceNode, getNameStart, getNodeStartForTooling, hasExplicitComment, hasNamespace, normalize, setASDocComment, setMetaTags, setModifiersContainer, setNamespace

Methods inherited from class org.apache.flex.compiler.internal.tree.as.TreeNode

addChild, addChild, addChildInOrder, addChildPostNormalize, addTemporaryChild, getChild, getChildCount, optimizeChildren, removeAllChildren, removeChild, removeTemporaryChild, replaceChild, sortChildren, swapChildren

Methods inherited from class org.apache.flex.compiler.internal.tree.as.NodeBase

buildStringRecursive, canContinueContainmentSearch, collectImportNodes, combineAttributes, connectedToProjectScope, contains, endAfter, endAfter, endBefore, endBefore, fillInOffsets, getAbsoluteEnd, getAbsoluteStart, getAncestorOfType, getASScope, getContainingFilePath, getContainingNode, getContainingScope, getEnd, getFileScope, getFileSpecification, getInnerString, getNodeKind, getPackageName, getParent, getScopeNode, getStart, getSucceedingNode, getWorkspace, isTerminal, isTransparent, looselyContains, runPostProcess, setParent, span, span, span, startAfter, startAfter, startBefore, startBefore, toString, tryGetOffsetLookup, verify

Methods inherited from class org.apache.flex.compiler.common.SourceLocation

getColumn, getEndColumn, getEndLine, getLine, getLineColumnString, getOffsetsString, getSourcePath, getSourcePathString, setColumn, setEnd, setEndColumn, setEndLine, setLine, setSourceLocation, setSourcePath, setStart, span, span

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

getAllMemberDefinitionNodes

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

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

contains, getAncestorOfType, getChild, getChildCount, getContainingNode, getContainingScope, getFileSpecification, getParent, 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

Field Detail

interfaceKeywordNode

protected KeywordNode interfaceKeywordNode

The class keyword

extendsKeywordNode

protected KeywordNode extendsKeywordNode

The extends keyword (if one is present)

baseInterfacesNode

protected TransparentContainerNode baseInterfacesNode

The collection of base interfaces

castFunctionNode

protected FunctionNode castFunctionNode

Generated FunctionNode to represent cast function

Constructor Detail

InterfaceNode

public InterfaceNode(ExpressionNodeBase name)

Constructor.

Parameters:

name - The node holding the interface name.

Method Detail

getNodeID

public ASTNodeID getNodeID()

Description copied from interface: IASNode

Get the opcode of this node

Specified by:

getNodeID in interface IASNode

Returns:

the opcode - this is one of the constants defined in ASTConstants

getSpanningStart

public int getSpanningStart()

Description copied from interface: IASNode

Gets the local offset where the node starts, including any extra items that may change the appearance of the node's start. These can include namespaces, keywords, modifiers, etc

Specified by:

getSpanningStart in interface IASNode

Overrides:

getSpanningStart in class BaseDefinitionNode

Returns:

the start of the span

setChildren

protected void setChildren(boolean fillInOffsets)

Description copied from class: NodeBase

If this node has custom children (names, arguments, etc), shove them into the list of children. Used during parsing.

Overrides:

setChildren in class NodeBase

analyze

protected void analyze(EnumSet<PostProcessStep> set,
           ASScope scope,
           Collection<ICompilerProblem> problems)

Overrides:

analyze in class BaseDefinitionNode

buildInnerString

protected boolean buildInnerString(StringBuilder sb)

Description copied from class: NodeBase

For debugging only. This method is called by buildOuterString(). It is overridden by subclasses to display optional node-specific information in the middle of the string, between the node type and the location information.

Overrides:

buildInnerString in class NodeBase

getInitialChildCount

protected int getInitialChildCount()

Description copied from class: TreeNode

Take a guess as to an efficient initial child count. We can override this in nodes that have a fixed number of children.

Overrides:

getInitialChildCount in class TreeNode

Returns:

initial size to use when creating children

init

protected void init(ExpressionNodeBase nameNode)

Overrides:

init in class BaseDefinitionNode

hasModifier

public boolean hasModifier(ASModifier modifier)

Description copied from interface: IDefinitionNode

Is the given modifier present on this definition? see ASModifier for the list of modifiers

Specified by:

hasModifier in interface IDefinitionNode

Overrides:

hasModifier in class BaseDefinitionNode

Returns:

true if the modifier is included in the set

getDefinition

public InterfaceDefinition getDefinition()

Description copied from interface: IInterfaceNode

Gets the symbol that represents this IInterfaceNode

Specified by:

getDefinition in interface IDefinitionNode

Specified by:

getDefinition in interface IInterfaceNode

Overrides:

getDefinition in class BaseDefinitionNode

Returns:

an IInterfaceDefinition that is the symbolic representation of this node

setDefinition

protected void setDefinition(IDefinition definition)

Overrides:

setDefinition in class BaseDefinitionNode

isImplicit

public boolean isImplicit()

Description copied from interface: IDefinitionNode

Is this definition an implicit definition that doesn't actually appear in the source file? Examples include this, super, default constructors, and cast functions.

Specified by:

isImplicit in interface IDefinitionNode

getQualifiedName

public String getQualifiedName()

Description copied from interface: IDefinitionNode

Get the qualified name of this type

Specified by:

getQualifiedName in interface IDefinitionNode

Returns:

the fully qualified name of this type

getShortName

public String getShortName()

Description copied from interface: IDefinitionNode

Get the short name of this type (without any package information)

Specified by:

getShortName in interface IDefinitionNode

Returns:

the short name of this type (without any package information)

getInterfaceClassification

public IInterfaceNode.InterfaceClassification getInterfaceClassification()

Description copied from interface: IInterfaceNode

Returns the classification of this ActionScript interface

Specified by:

getInterfaceClassification in interface IInterfaceNode

Returns:

the IInterfaceNode.InterfaceClassification

getExtendedInterfaceNodes

public IExpressionNode[] getExtendedInterfaceNodes()

Description copied from interface: IInterfaceNode

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

Specified by:

getExtendedInterfaceNodes in interface IInterfaceNode

Returns:

an array of interface names, or an empty array

getExtendedInterfaces

public String[] getExtendedInterfaces()

Description copied from interface: IInterfaceNode

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

Specified by:

getExtendedInterfaces in interface IInterfaceNode

Returns:

an array of interface names, or an empty array

setInterfaceKeyword

public void setInterfaceKeyword(IASToken interfaceKeyword)

Sets the interface keyword. Used during parsing.

Parameters:

interfaceKeyword - token containing the keyword

getClassKeywordNode

public KeywordNode getClassKeywordNode()

Get the node containing the class keyword

Returns:

the node containing class

getExtendsKeywordNode

public KeywordNode getExtendsKeywordNode()

Get the node containing the extends keyword, if one exists

Returns:

the node containing extends

setExtendsKeyword

public void setExtendsKeyword(IASToken extendsKeyword)

Sets the extends keyword if one is present. Used during parsing.

Parameters:

extendsKeyword - token containing the keyword

addBaseInterface

public void addBaseInterface(ExpressionNodeBase interfaceName)

Add an implemented interface to this class. Used during parsing.

Parameters:

interfaceName - node containing the interface name

getBaseInterfacesNode

public ContainerNode getBaseInterfacesNode()

Get the container of base interfaces for this interfaces

Returns:

the node containing the base interfaces

getCastFunctionNode

public FunctionNode getCastFunctionNode()

Get the dummy node representing the cast function

Returns:

cast function