Package com.sun.tools.javac.util

Class RawDiagnosticFormatter

java.lang.Object

com.sun.tools.javac.util.AbstractDiagnosticFormatter

com.sun.tools.javac.util.RawDiagnosticFormatter

All Implemented Interfaces:

DiagnosticFormatter<JCDiagnostic>

public final class RawDiagnosticFormatter
extends AbstractDiagnosticFormatter

A raw formatter for diagnostic messages. The raw formatter will format a diagnostic according to one of two format patterns, depending on whether or not the source name and position are set. This formatter provides a standardized, localize-independent implementation of a diagnostic formatter; as such, this formatter is best suited for testing purposes.

This is NOT part of any supported API. If you write code that depends on this, you do so at your own risk. This code and its internal interfaces are subject to change or deletion without notice.

Nested Class Summary

Nested classes/interfaces inherited from class com.sun.tools.javac.util.AbstractDiagnosticFormatter

AbstractDiagnosticFormatter.SimpleConfiguration

Nested classes/interfaces inherited from interface com.sun.tools.javac.api.DiagnosticFormatter

DiagnosticFormatter.Configuration, DiagnosticFormatter.PositionKind

Field Summary

Fields inherited from class com.sun.tools.javac.util.AbstractDiagnosticFormatter

depth, messages, printer

Constructor Summary

Constructors

Constructor and Description
RawDiagnosticFormatter(Options options) Create a formatter based on the supplied options.

Method Summary

Modifier and Type	Method and Description
protected String	formatArgument(JCDiagnostic diag, Object arg, Locale l) Format a single argument of a given diagnostic.
String	formatDiagnostic(JCDiagnostic d, Locale l)
String	formatMessage(JCDiagnostic d, Locale l) Controls the way in which a diagnostic message is displayed.
boolean	isRaw()
protected String	localize(Locale l, String key, Object... args) Converts a String into a locale-dependent representation accordingly to a given locale.

Methods inherited from class com.sun.tools.javac.util.AbstractDiagnosticFormatter

displaySource, format, formatArguments, formatIterable, formatKind, formatLintCategory, formatPosition, formatSource, formatSourceLine, formatSubdiagnostic, formatSubdiagnostics, getConfiguration, getPrinter, indent, indentString, setPrinter

Methods inherited from class java.lang.Object

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

Constructor Detail

RawDiagnosticFormatter

public RawDiagnosticFormatter(Options options)

Create a formatter based on the supplied options.

Parameters:

options -

Method Detail

formatDiagnostic

public String formatDiagnostic(JCDiagnostic d,
                               Locale l)

Specified by:

formatDiagnostic in class AbstractDiagnosticFormatter

formatMessage

public String formatMessage(JCDiagnostic d,
                            Locale l)

Description copied from interface: DiagnosticFormatter

Controls the way in which a diagnostic message is displayed.

Parameters:

d - diagnostic to be formatted

l - locale object to be used for i18n

Returns:

string representation of the diagnostic message

formatArgument

protected String formatArgument(JCDiagnostic diag,
                                Object arg,
                                Locale l)

Description copied from class: AbstractDiagnosticFormatter

Format a single argument of a given diagnostic.

Overrides:

formatArgument in class AbstractDiagnosticFormatter

Parameters:

diag - diagnostic whose argument is to be formatted

arg - argument to be formatted

l - locale object to be used for i18n

Returns:

string representation of the diagnostic argument

localize

protected String localize(Locale l,
                          String key,
                          Object... args)

Description copied from class: AbstractDiagnosticFormatter

Converts a String into a locale-dependent representation accordingly to a given locale.

Overrides:

localize in class AbstractDiagnosticFormatter

Parameters:

l - locale object to be used for i18n

key - locale-independent key used for looking up in a resource file

args - localization arguments

Returns:

a locale-dependent string

isRaw

public boolean isRaw()

Overrides:

isRaw in class AbstractDiagnosticFormatter