org.apache.flex.compiler.tree.as

Interface IFileNode

All Superinterfaces:

IASNode, IScopedNode, ISourceLocation

All Known Subinterfaces:

IMXMLFileNode, IOldMXMLFileNode, IResourceBundleFileNode

All Known Implementing Classes:

FileNode, FXGFileNode, MXMLFileNode, ResourceBundleFileNode

public interface IFileNode
extends IScopedNode

An AST node representing an ActionScript file being compiled.

An IFileNode is the root of the AST (abstract syntax tree) produced for a file.

If the file includes other files, a single IFileNode is produced.

The shape of this node is

 IFileNode
   IASNode <-- getChild(0)
   IASNode <-- getChild(1)
   ...
 

Field Summary

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

UNKNOWN

Method Summary

Methods

Modifier and Type	Method and Description
long	getIncludeTreeLastModified() Returns a last modification timestamp of the current include file tree
OffsetLookup	getOffsetLookup()
Collection<ICompilerProblem>	getProblems() Returns the problems that are contained in this file.
ITargetAttributes	getTargetAttributes(ICompilerProject project) If this IFileNode can be used as the MXML main application or ActionScript main class, it returns attributes related to SWF target.
IDefinitionNode[]	getTopLevelDefinitionNodes(boolean includeDefinitionsOutsideOfPackage, boolean includeNonPublicDefinitions) Gets definition nodes within this file node that are children of the file node or children of a package block node.
IDefinition[]	getTopLevelDefinitions(boolean includeDefinitionsOutsideOfPackage, boolean includeNonPublicDefinitions) Gets the definitions corresponding to the definitions nodes within this file node that are children of the file node or children of a package block node.
boolean	hasIncludes()
void	populateFunctionNodes() Rebuild function body nodes.

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

getAllImportNodes, getAllImports, getScope

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

contains, getAncestorOfType, getChild, getChildCount, getContainingNode, getContainingScope, getFileSpecification, getNodeID, getPackageName, getParent, getSpanningStart, getSucceedingNode, isTerminal

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

getAbsoluteEnd, getAbsoluteStart, getColumn, getEnd, getEndColumn, getEndLine, getLine, getSourcePath, getStart

Method Detail

getIncludeTreeLastModified

long getIncludeTreeLastModified()

Returns a last modification timestamp of the current include file tree

Returns:

a timestamp

hasIncludes

boolean hasIncludes()

Returns:

True is this file contains any include statements

getOffsetLookup

OffsetLookup getOffsetLookup()

Returns:

OffsetLookup object of this file node.

getTargetAttributes

ITargetAttributes getTargetAttributes(ICompilerProject project)

If this IFileNode can be used as the MXML main application or ActionScript main class, it returns attributes related to SWF target. Otherwise, this method returns null.

Parameters:

project - Context project.

Returns:

Target attributes collected from special MXML attributes or ActionScript metadata tag.

getTopLevelDefinitionNodes

IDefinitionNode[] getTopLevelDefinitionNodes(boolean includeDefinitionsOutsideOfPackage,
                                           boolean includeNonPublicDefinitions)

Gets definition nodes within this file node that are children of the file node or children of a package block node.

Parameters:

includeDefinitionsOutsideOfPackage - A flag indicating whether definition nodes that aren't in a package should be included.

includeNonPublicDefinitions - A flag indicating whether definition nodes that don't have a public keyword should be included.

Returns:

An array of IDefinitionNode objects.

getTopLevelDefinitions

IDefinition[] getTopLevelDefinitions(boolean includeDefinitionsOutsideOfPackage,
                                   boolean includeNonPublicDefinitions)

Gets the definitions corresponding to the definitions nodes within this file node that are children of the file node or children of a package block node.

Parameters:

includeDefinitionsOutsideOfPackage - A flag indicating whether definitions that aren't in a package should be included.

includeNonPublicDefinitions - A flag indicating whether definitions that don't have a public keyword should be included.

Returns:

An array of IDefinition objects.

getProblems

Collection<ICompilerProblem> getProblems()

Returns the problems that are contained in this file.

Returns:

An array of ICompilerProblem objects

populateFunctionNodes

void populateFunctionNodes()

Rebuild function body nodes.