com.adobe.flexbuilder.codemodel.tree
Interface IFileNode

All Superinterfaces:

com.adobe.flexbuilder.codemodel.internal.testing.IAdaptableNode, IASNode, IScopedNode

public interface IFileNode

extends IScopedNode

An IFileNode is the root node for a file's ActionScript parse tree.

Method Summary

IDefinition[]	getAllTopLevelDefinitions(boolean includeDefinitionsOutsideOfPackage, boolean includeNonPublicDefinitions) Retrieve all top-level definitions (classes, interfaces, functions, and variables) in this file.
long	getFileTimeStamp() Returns the timestamp of the file we point to on the current FS
java.lang.String	getPackageNameForFile() If this file is a legal part of the source folder or a class path, then figure out its package name should be (based on the folder hierarchy)
java.lang.String	getPath() Get the path name of this file
boolean	hasIncludes()

Methods inherited from interface com.adobe.flexbuilder.codemodel.tree.IScopedNode

getScope

Methods inherited from interface com.adobe.flexbuilder.codemodel.tree.IASNode

getAncestorOfType, getChild, getChildCount, getChildren, getEnd, getNodeStackTrace, getNodeType, getPackageName, getParent, getSpanningStart, getStart

Methods inherited from interface com.adobe.flexbuilder.codemodel.internal.testing.IAdaptableNode

getAdaptableAttribute, getAdaptableAttributes, getAdaptableChildren, getAdaptableName

Method Detail

getPath

public java.lang.String getPath()

Get the path name of this file

Returns:

the path name of this file

getAllTopLevelDefinitions

public IDefinition[] getAllTopLevelDefinitions(boolean includeDefinitionsOutsideOfPackage,
                                               boolean includeNonPublicDefinitions)

Retrieve all top-level definitions (classes, interfaces, functions, and variables) in this file.

Parameters:

includeDefinitionsOutsideOfPackage - flag indicating whether we should include definitions that aren't in a package definition

includeNonPublicDefinitions - flag indicating whether we should include definitions that don't have a public keyword

Returns:

array of top-level definitions in this file

getPackageNameForFile

public java.lang.String getPackageNameForFile()

If this file is a legal part of the source folder or a class path, then figure out its package name should be (based on the folder hierarchy)

Returns:

package name based on folder hierarchy

getFileTimeStamp

public long getFileTimeStamp()

Returns the timestamp of the file we point to on the current FS

Returns:

a timestamp

hasIncludes

public boolean hasIncludes()

Returns:

True is this file contains any include statements