org.apache.flex.compiler.clients.problems

Class ProblemQuery

java.lang.Object

org.apache.flex.compiler.clients.problems.ProblemQuery

public class ProblemQuery
extends Object

A ProblemQuery presents a higher-level view of a problem stream; it offers facilities to enable or disable diagnostics and presents filtered and (optionally) sorted views of the underlying problem stream.

Field Summary

Fields

Modifier and Type	Field and Description
static Comparator<ICompilerProblem>	compareByPositionAndPhase This Comparator compares problems based on three criteria: file path line number problem class - ParserProblems are "less than" semantic problems.

Constructor Summary

Constructors

Constructor and Description
ProblemQuery() Construct a ProblemQuery.
ProblemQuery(ICompilerProblemSettings problemSettings) Construct a ProblemQuery with settings to control how compiler problems are reported.

Method Summary

Methods

Modifier and Type	Method and Description
void	add(ICompilerProblem problem) Add a single problem to the problems collection.
void	addAll(ICompilerProblem[] newProblems) Add an array of compiler problems to the problems collection.
void	addAll(Iterable<ICompilerProblem> newProblems) Add a collection of compiler problems to the problems collection.
void	clear() Clear the underlying collection of problems.
void	getErrorsAndWarnings(Collection<ICompilerProblem> errors, Collection<ICompilerProblem> warnings) Categorize the compiler problems into two bins, errors and warning.
Iterable<ICompilerProblem>	getFilteredProblems() Get an iterator over the set of problems that are to be reported based on the current settings.
Iterable<ICompilerProblem>	getInternalErrors() Get an iterator over all internal errors.
List<ICompilerProblem>	getProblems() Gets the list of compiler problems, with no filtering or sorting.
Iterable<ICompilerProblem>	getProblemView(IProblemFilter filter) Get a filtered view of the underlying problems.
boolean	hasErrors() Test if any of the problems are errors.
boolean	hasFilteredProblems() Any problems to report after filtering?
boolean	hasFilteredProblems(IProblemFilter filter) Do any problems match the given filter?
void	setShowInternalErrors(boolean showInternalErrors) Enable or disable internal error display.
void	setShowIrrelevantProblems(boolean showIrrelevantProblems) Enable or disable display of "problems" that are used for compiler internal processing but have no relevance to the user.
void	setShowProblemByClass(Class<? extends ICompilerProblem> problemClass, boolean enable) Enable or disable display of a specific problem class or superclass.
void	setShowStrictSemantics(boolean isStrict) Enable or disable strict semantics mode diagnostics.
void	setShowWarnings(boolean showWarnings) Enable or disable semantic warnings.
void	sortProblems() Sort the captured collection of problems so that we can filter out semantic problems that occur on the same line as parser problems.

Methods inherited from class java.lang.Object

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

Field Detail

compareByPositionAndPhase

public static final Comparator<ICompilerProblem> compareByPositionAndPhase

This Comparator compares problems based on three criteria:

file path line number problem class - ParserProblems are "less than" semantic problems.

Constructor Detail

ProblemQuery

public ProblemQuery()

Construct a ProblemQuery.

ProblemQuery

public ProblemQuery(ICompilerProblemSettings problemSettings)

Construct a ProblemQuery with settings to control how compiler problems are reported.

Parameters:

problemSettings - configuration settings to control how compiler problems are reported.

Method Detail

getProblems

public List<ICompilerProblem> getProblems()

Gets the list of compiler problems, with no filtering or sorting.

setShowStrictSemantics

public void setShowStrictSemantics(boolean isStrict)

Enable or disable strict semantics mode diagnostics.

Parameters:

isStrict - - if true, strict semantics mode diagnostics will appear in the filtered diagnostics.

setShowWarnings

public void setShowWarnings(boolean showWarnings)

Enable or disable semantic warnings.

Parameters:

showWarnings - - if true, semantic warnings will appear in the filtered diagnostics.

setShowInternalErrors

public void setShowInternalErrors(boolean showInternalErrors)

Enable or disable internal error display.

Parameters:

showInternalErrors - - if true, internal error diagnostics will appear in the filtered diagnostics.

setShowIrrelevantProblems

public void setShowIrrelevantProblems(boolean showIrrelevantProblems)

Enable or disable display of "problems" that are used for compiler internal processing but have no relevance to the user.

Parameters:

showIrrelevantProblems - - if true, non-user-relevant diagnostics will appear in the filtered diagnostics.

setShowProblemByClass

public void setShowProblemByClass(Class<? extends ICompilerProblem> problemClass,
                         boolean enable)

Enable or disable display of a specific problem class or superclass.

Parameters:

problemClass - - the problem class/superclass of interest.

enable - - if true, instances of this problem class will appear in the filtered diagnostics.

addAll

public void addAll(ICompilerProblem[] newProblems)

Add an array of compiler problems to the problems collection.

Parameters:

newProblems - - the problems to add.

addAll

public void addAll(Iterable<ICompilerProblem> newProblems)

Add a collection of compiler problems to the problems collection.

Parameters:

newProblems - - the problems to add.

add

public void add(ICompilerProblem problem)

Add a single problem to the problems collection.

Parameters:

problem - - the problem to add.

clear

public void clear()

Clear the underlying collection of problems.

getFilteredProblems

public Iterable<ICompilerProblem> getFilteredProblems()

Get an iterator over the set of problems that are to be reported based on the current settings. Problem categorization is built into this filter so that problems categorized as "ignore" are filtered out.

Returns:

an Iterable<ICompilerProblem> over the subset of problems that are of interest to the client.

hasFilteredProblems

public boolean hasFilteredProblems()

Any problems to report after filtering?

Returns:

true if there are filtered problems.

hasFilteredProblems

public boolean hasFilteredProblems(IProblemFilter filter)

Do any problems match the given filter?

Parameters:

filter - - the problem filter of interest.

getProblemView

public Iterable<ICompilerProblem> getProblemView(IProblemFilter filter)

Get a filtered view of the underlying problems.

Parameters:

filter - - the filter to apply.

Returns:

an Iterable that supplies a filtered iterator of the problems.

getInternalErrors

public Iterable<ICompilerProblem> getInternalErrors()

Get an iterator over all internal errors.

sortProblems

public void sortProblems()

Sort the captured collection of problems so that we can filter out semantic problems that occur on the same line as parser problems.

getErrorsAndWarnings

public void getErrorsAndWarnings(Collection<ICompilerProblem> errors,
                        Collection<ICompilerProblem> warnings)

Categorize the compiler problems into two bins, errors and warning.

Parameters:

errors - the collection where the errors are added.

warnings - the collection where the warnings are added.

hasErrors

public boolean hasErrors()

Test if any of the problems are errors. return true if any of the problems are errors, false otherwise.