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

Class ClassNode

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.ClassNode

All Implemented Interfaces:

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

public class ClassNode
extends MemberedNode
implements IClassNode

ActionScript parse tree node representing a class definition

Field Summary

Fields

Modifier and Type	Field and Description
protected ExpressionNodeBase	baseClassNode The name of the base class
protected KeywordNode	classKeywordNode The class keyword
protected FunctionNode	constructorNode Generated FunctionNode to represent explicit or default constructor
protected FunctionNode	defaultConstructorNode Generated FunctionNode to represent default constructor (if there isn't an explicit one)
protected KeywordNode	extendsKeywordNode The extends keyword (if one is present)
protected KeywordNode	implementsKeywordNode The extends keyword (if one is present)
protected TransparentContainerNode	interfacesNode Container full of interfaces implemented by this class

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
ClassNode(ExpressionNodeBase name) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	addInterface(ExpressionNodeBase interfaceName) Add an implemented interface to this class.
protected void	analyze(EnumSet<PostProcessStep> set, ASScope scope, Collection<ICompilerProblem> problems)
void	buildExplicitMemberDefs(TypeScope classScope) Method that will only build the explicit definitions for this AS3 class.
protected boolean	buildInnerString(StringBuilder sb) For debugging only.
boolean	canCacheMetaTags() If a classes containing file has includes, it's metadata values cannot be cached
IDefinitionNode[]	getAllMemberNodes() Returns an array of IDefinitionNode objects that represent all the children of this class that are members.
IExpressionNode	getBaseClassExpressionNode()
String	getBaseClassName() Returns the name of this class' base class, if it exists.
ExpressionNodeBase	getBaseClassNode() Get the node containing the base class, if one exists
IClassDefinition.ClassClassification	getClassClassification() Returns the classification of this ActionScript class
KeywordNode	getClassKeywordNode() Get the node containing the class keyword
FunctionNode	getConstructorNode() Get the node representing the constructor
FunctionNode	getDefaultConstructorNode() Get the node representing the default constructor (if there's no explicit constructor)
ClassDefinition	getDefinition() Returns the class definition corresponding to this class node.
KeywordNode	getExtendsKeywordNode() Get the node containing the extends keyword, if one exists
IExpressionNode[]	getImplementedInterfaceNodes()
String[]	getImplementedInterfaces() Returns the names of any interfaces that this class declares it implements.
KeywordNode	getImplementsKeywordNode() Get the node containing the implements keyword, if one exists
protected int	getInitialChildCount() Take a guess as to an efficient initial child count.
String[]	getInterfaceNames() Get the implemented interface names (as they appear in the class definition)
ContainerNode	getInterfacesNode() Get the container of interfaces for this class
IMetaTagNode[]	getMetaTagNodesByName(String name) Retrieve all of the meta attributes (e.g.
IMetaTag[]	getMetaTagsByName(String name) Retrieve all of the meta attributes (e.g.
protected void	getMetaTagsByName(String name, RecursionGuard recursionGuard, ArrayList<IMetaTagNode> allMatchingAttributes) Retrieves all of the matching meta attributes associated with this class or any of its base classes
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.
protected void	init(ExpressionNodeBase nameNode)
boolean	isImplicit() Is this definition an implicit definition that doesn't actually appear in the source file?
void	setBaseClass(ExpressionNodeBase baseClassNode) Set the base class of this class.
protected void	setChildren(boolean fillInOffsets) If this node has custom children (names, arguments, etc), shove them into the list of children.
void	setClassKeyword(IASToken classKeyword) Sets the class keyword if one is present.
void	setDefinition(IDefinition def)
void	setExtendsKeyword(IASToken extendsKeyword) Sets the extends keyword if one is present.
void	setImplementsKeyword(IASToken implementsKeyword) Sets the implements keyword if one is present.

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, hasModifier, 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.IScopedDefinitionNode

getScopedNode

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

getContainingFilePath, getMetaInfos, getMetaTags, getName, getNameAbsoluteEnd, getNameAbsoluteStart, getNameEnd, getNameExpressionNode, getNamespace, getNameStart, getPackageName, hasModifier, 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

classKeywordNode

protected KeywordNode classKeywordNode

The class keyword

extendsKeywordNode

protected KeywordNode extendsKeywordNode

The extends keyword (if one is present)

baseClassNode

protected ExpressionNodeBase baseClassNode

The name of the base class

implementsKeywordNode

protected KeywordNode implementsKeywordNode

The extends keyword (if one is present)

interfacesNode

protected TransparentContainerNode interfacesNode

Container full of interfaces implemented by this class

constructorNode

protected FunctionNode constructorNode

Generated FunctionNode to represent explicit or default constructor

defaultConstructorNode

protected FunctionNode defaultConstructorNode

Generated FunctionNode to represent default constructor (if there isn't an explicit one)

Constructor Detail

ClassNode

public ClassNode(ExpressionNodeBase name)

Constructor.

Parameters:

name - The node holding this class 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

getDefinition

public ClassDefinition getDefinition()

Description copied from interface: ICommonClassNode

Returns the class definition corresponding to this class node.

Specified by:

getDefinition in interface ICommonClassNode

Specified by:

getDefinition in interface IDefinitionNode

Overrides:

getDefinition in class BaseDefinitionNode

setDefinition

public void setDefinition(IDefinition def)

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)

getClassClassification

public IClassDefinition.ClassClassification getClassClassification()

Description copied from interface: ICommonClassNode

Returns the classification of this ActionScript class

Specified by:

getClassClassification in interface ICommonClassNode

Returns:

the IClassDefinition.ClassClassification object

getMetaTagsByName

public IMetaTag[] getMetaTagsByName(String name)

Description copied from interface: ICommonClassNode

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.

Specified by:

getMetaTagsByName in interface ICommonClassNode

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)

getMetaTagNodesByName

public IMetaTagNode[] getMetaTagNodesByName(String name)

Description copied from interface: IClassNode

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

Specified by:

getMetaTagNodesByName in interface IClassNode

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)

getBaseClassExpressionNode

public IExpressionNode getBaseClassExpressionNode()

Specified by:

getBaseClassExpressionNode in interface IClassNode

getBaseClassName

public String getBaseClassName()

Description copied from interface: ICommonClassNode

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

Specified by:

getBaseClassName in interface ICommonClassNode

Returns:

the name of the base class, or null

getImplementedInterfaceNodes

public IExpressionNode[] getImplementedInterfaceNodes()

Specified by:

getImplementedInterfaceNodes in interface IClassNode

getImplementedInterfaces

public String[] getImplementedInterfaces()

Description copied from interface: ICommonClassNode

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

Specified by:

getImplementedInterfaces in interface ICommonClassNode

Returns:

an array of interface names, or an empty array

getAllMemberNodes

public IDefinitionNode[] getAllMemberNodes()

Description copied from interface: IClassNode

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

Specified by:

getAllMemberNodes in interface IClassNode

Returns:

an array of IDefinitionNode children, or an empty array

setClassKeyword

public void setClassKeyword(IASToken classKeyword)

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

Parameters:

classKeyword - token containing the keyword

setExtendsKeyword

public void setExtendsKeyword(IASToken extendsKeyword)

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

Parameters:

extendsKeyword - token containing the keyword

setBaseClass

public void setBaseClass(ExpressionNodeBase baseClassNode)

Set the base class of this class. Used during parsing.

Parameters:

baseClassNode - node containing the base class name

setImplementsKeyword

public void setImplementsKeyword(IASToken implementsKeyword)

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

Parameters:

implementsKeyword - token containing the keyword

addInterface

public void addInterface(ExpressionNodeBase interfaceName)

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

Parameters:

interfaceName - node containing the interface name

buildExplicitMemberDefs

public void buildExplicitMemberDefs(TypeScope classScope)

Method that will only build the explicit definitions for this AS3 class. This is used by the MXML scope build code to build definitions for a <fx:Script> tag.

Parameters:

classScope - TypeScope into which this AS3 class' definition should be added.

getConstructorNode

public FunctionNode getConstructorNode()

Get the node representing the constructor

Returns:

explicit or default constructor

getDefaultConstructorNode

public FunctionNode getDefaultConstructorNode()

Get the node representing the default constructor (if there's no explicit constructor)

Returns:

default constructor

getInterfaceNames

public String[] getInterfaceNames()

Get the implemented interface names (as they appear in the class definition)

Returns:

array of interface names

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

getBaseClassNode

public ExpressionNodeBase getBaseClassNode()

Get the node containing the base class, if one exists

Returns:

the node containing the base class

getImplementsKeywordNode

public KeywordNode getImplementsKeywordNode()

Get the node containing the implements keyword, if one exists

Returns:

the node containing implements

getInterfacesNode

public ContainerNode getInterfacesNode()

Get the container of interfaces for this class

Returns:

the node containing the interfaces

getMetaTagsByName

protected void getMetaTagsByName(String name,
                     RecursionGuard recursionGuard,
                     ArrayList<IMetaTagNode> allMatchingAttributes)

Retrieves all of the matching meta attributes associated with this class or any of its base classes

Parameters:

name - name of meta attributes to retrieve

recursionGuard - guard to help avoid infinite loops in the base class hierarchy

allMatchingAttributes - list to be filled with all matching meta attributes

canCacheMetaTags

public boolean canCacheMetaTags()

If a classes containing file has includes, it's metadata values cannot be cached

Returns:

true if they can be cached