org.apache.flex.compiler.clients.problems

Class ProblemFormatter

java.lang.Object

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

Direct Known Subclasses:

WorkspaceProblemFormatter

public class ProblemFormatter
extends Object

Abstract class that provide useful functionality for formatting and retrieving the localized message of CompilerProblem's.

Field Summary

Fields

Modifier and Type	Field and Description
static ProblemFormatter	DEFAULT_FORMATTER

Constructor Summary

Constructors

Constructor and Description
ProblemFormatter()

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	getMessage(String key) Returns message for the specified key using the resource bundle generated for the specified locale.
static String	substitute(String text, Map<String,Object> parameters) Resolves the tokens in the text using the key/value pairs in the specified map.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_FORMATTER

public static ProblemFormatter DEFAULT_FORMATTER

Constructor Detail

ProblemFormatter

public ProblemFormatter()

Method Detail

format

public 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.

Parameters:

problem - problem whose message to find

Returns:

A localized readable description of the problem.

substitute

public static String substitute(String text,
                Map<String,Object> parameters)

Resolves the tokens in the text using the key/value pairs in the specified map. Each token in the message is searched in the map's key list and if found, the token replaced with the value of found key.

Parameters:

text - compiler message to resolve

parameters - map that contains key/value pairs used to resolve the tokens in the specified message.

Returns:

resolved, token-free compiler message

getMessage

protected String getMessage(String key)

Returns message for the specified key using the resource bundle generated for the specified locale.

Parameters:

key - key to find (should be the class name of the problem class)

Returns:

the message associated with the specified key