org.apache.flex.compiler.clients.problems

Class WorkspaceProblemFormatter

java.lang.Object

org.apache.flex.compiler.clients.problems.ProblemFormatter

org.apache.flex.compiler.clients.problems.WorkspaceProblemFormatter

public final class WorkspaceProblemFormatter
extends ProblemFormatter

Problem formatter class that reports more detailed readable description of a problem. In addition to the problem message, this class reports the text where the problem occurred if any. This class requires a Workspace to access problem's file and the necessary line information. All the command line tools such as MXMLC, ASC should use this class for problem reporting as we would like to give as much detail as possible to the users in command line.

Field Summary

Fields inherited from class org.apache.flex.compiler.clients.problems.ProblemFormatter

DEFAULT_FORMATTER

Constructor Summary

Constructors

Constructor and Description
WorkspaceProblemFormatter(Workspace workspace) Constructor.
WorkspaceProblemFormatter(Workspace workspace, CompilerProblemCategorizer problemCategorizer) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
String	format(ICompilerProblem problem) Returns a readable description of the problem, by substituting field values for named placeholders such as ${name} in the message specified for this compiler problem.
protected String	getLineText(ICompilerProblem problem) Gets the text of the line specified problem occured or null if there is no line information.

Methods inherited from class org.apache.flex.compiler.clients.problems.ProblemFormatter

getMessage, substitute

Methods inherited from class java.lang.Object

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

Constructor Detail

WorkspaceProblemFormatter

public WorkspaceProblemFormatter(Workspace workspace)

Constructor.

Parameters:

workspace - workspace that contains files associated with specified problems.

WorkspaceProblemFormatter

public WorkspaceProblemFormatter(Workspace workspace,
                         CompilerProblemCategorizer problemCategorizer)

Constructor.

Parameters:

workspace - workspace that contains files associated with specified problems.

problemCategorizer - a class the categorizes problems into one of the values in CompilerProblemSeverity. Adds "Error:" and "Warning:" into the format of a problem. If null, the problem categories will not be added to the output.

Method Detail

format

public String format(ICompilerProblem problem)

Description copied from class: ProblemFormatter

Returns a readable description of the problem, by substituting field values for named placeholders such as ${name} in the message specified for this compiler problem.

Overrides:

format in class ProblemFormatter

Parameters:

problem - problem whose message to find

Returns:

A localized readable description of the problem.

getLineText

protected String getLineText(ICompilerProblem problem)

Gets the text of the line specified problem occured or null if there is no line information.

Parameters:

problem - problem to process

Returns:

the text of the line or null if there is no line information