org.apache.flex.compiler.internal.units.requests

Class FileScopeRequestResultBase

java.lang.Object

org.apache.flex.compiler.internal.units.requests.FileScopeRequestResultBase

All Implemented Interfaces:

IFileScopeRequestResult, IRequestResult

Direct Known Subclasses:

ABCFileScopeRequestResult, ASFileScopeRequestResult, EmbedFileScopeRequestResult

public class FileScopeRequestResultBase
extends Object
implements IFileScopeRequestResult

Base implementation of an IFileScopeRequestResult.

Field Summary

Fields

Modifier and Type	Field and Description
protected Collection<IDefinition>	definitions All the public definitions in the given file scope.

Constructor Summary

Constructors

Constructor and Description
FileScopeRequestResultBase(Collection<ICompilerProblem> problems, Collection<? extends IASScope> scopes) Create an immutable IFileScopeRequestResult object.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addProblems(Collection<ICompilerProblem> newProblems) This method allows sub-classes to add problems to the problems collection after running this classes constructor.
Collection<ICompilerProblem>	checkExternallyVisibleDefinitions(String dottedQName) Create compiler problems if the a definition with the specified dotted qualified name is not defined in the IASScopes in this result object or if there is an externally visible definition other than the named definition.
Collection<IDefinition>	getExternallyVisibleDefinitions() Get all the public definitions.
ASFileScope[]	getFileScopes()
IDefinition	getMainDefinition(String qname)
ICompilerProblem[]	getProblems()
IASScope[]	getScopes()

Methods inherited from class java.lang.Object

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

Field Detail

definitions

protected final Collection<IDefinition> definitions

All the public definitions in the given file scope.

Constructor Detail

FileScopeRequestResultBase

public FileScopeRequestResultBase(Collection<ICompilerProblem> problems,
                          Collection<? extends IASScope> scopes)

Create an immutable IFileScopeRequestResult object.

Parameters:

problems - All the compiler problems will be stored in this collection.

scopes - Top-level scopes in this request result. The public definitions in the scopes will be collected and stored in field definitions.

Method Detail

getProblems

public ICompilerProblem[] getProblems()

Specified by:

getProblems in interface IRequestResult

Returns:

ICompilerProblems found while computing the result of the request.

getScopes

public IASScope[] getScopes()

Specified by:

getScopes in interface IFileScopeRequestResult

Returns:

The root IASScope instances for this CompilationUnit. For a compilation unit that processes a source file, the array will contain a single ASFileScope. For a compilation unit that processes ABC, the array will contain one ASFileScope for each "script" in the ABC.

getFileScopes

public ASFileScope[] getFileScopes()

getMainDefinition

public IDefinition getMainDefinition(String qname)

Specified by:

getMainDefinition in interface IFileScopeRequestResult

Returns:

The externally-visible definition in this compilation unit whose fully-qualified name matches the filepath for the compilation unit, (if one was specified), or null if no such definition exists.

getExternallyVisibleDefinitions

public Collection<IDefinition> getExternallyVisibleDefinitions()

Get all the public definitions.

Specified by:

getExternallyVisibleDefinitions in interface IFileScopeRequestResult

Returns:

public definitions

addProblems

protected void addProblems(Collection<ICompilerProblem> newProblems)

This method allows sub-classes to add problems to the problems collection after running this classes constructor.

Parameters:

newProblems - Collection of ICompilerProblem's to add to the problems list for this result object.

checkExternallyVisibleDefinitions

public Collection<ICompilerProblem> checkExternallyVisibleDefinitions(String dottedQName)

Description copied from interface: IFileScopeRequestResult

Create compiler problems if the a definition with the specified dotted qualified name is not defined in the IASScopes in this result object or if there is an externally visible definition other than the named definition.

Specified by:

checkExternallyVisibleDefinitions in interface IFileScopeRequestResult

Parameters:

dottedQName - The dotted fully qualified definition name of the definition that should be the only definition in the IASScopes in this result object.

Returns:

Collection of ICompilerProblems