Package com.sun.tools.javac.util

Class AbstractDiagnosticFormatter

java.lang.Object

com.sun.tools.javac.util.AbstractDiagnosticFormatter

All Implemented Interfaces:

DiagnosticFormatter<JCDiagnostic>

Direct Known Subclasses:

BasicDiagnosticFormatter, RawDiagnosticFormatter

public abstract class AbstractDiagnosticFormatter
extends Object
implements DiagnosticFormatter<JCDiagnostic>

This abstract class provides a basic implementation of the functionalities that should be provided by any formatter used by javac. Among the main features provided by AbstractDiagnosticFormatter are:

• Provides a standard implementation of the visitor-like methods defined in the interface DiagnisticFormatter. Those implementations are specifically targeting JCDiagnostic objects.
• Provides basic support for i18n and a method for executing all locale-dependent conversions
• Provides the formatting logic for rendering the arguments of a JCDiagnostic object.

  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

Modifier and Type	Class and Description
static class	AbstractDiagnosticFormatter.SimpleConfiguration

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

DiagnosticFormatter.Configuration, DiagnosticFormatter.PositionKind

Field Summary

Fields

Modifier and Type	Field and Description
protected int	depth Current depth level of the disgnostic being formatted (!= 0 for subdiagnostics)
protected JavacMessages	messages JavacMessages object used by this formatter for i18n.
protected Printer	printer An enhanced printer for formatting types/symbols used by AbstractDiagnosticFormatter.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractDiagnosticFormatter(JavacMessages messages, AbstractDiagnosticFormatter.SimpleConfiguration config) Initialize an AbstractDiagnosticFormatter by setting its JavacMessages object.

Method Summary

Modifier and Type	Method and Description
boolean	displaySource(JCDiagnostic d) Whether the source code output for this diagnostic is to be displayed.
String	format(JCDiagnostic d, Locale locale) Format the contents of a diagnostics.
protected String	formatArgument(JCDiagnostic d, Object arg, Locale l) Format a single argument of a given diagnostic.
protected Collection<String>	formatArguments(JCDiagnostic d, Locale l) Format the arguments of a given diagnostic.
protected abstract String	formatDiagnostic(JCDiagnostic d, Locale locale)
protected String	formatIterable(JCDiagnostic d, Iterable<?> it, Locale l) Format an iterable argument of a given diagnostic.
String	formatKind(JCDiagnostic d, Locale l) Controls the way in which a diagnostic kind is displayed.
protected String	formatLintCategory(JCDiagnostic d, Locale l)
String	formatPosition(JCDiagnostic d, DiagnosticFormatter.PositionKind pk, Locale l) Controls the way in which a diagnostic position is displayed.
String	formatSource(JCDiagnostic d, boolean fullname, Locale l) Controls the way in which a diagnostic source is displayed.
protected String	formatSourceLine(JCDiagnostic d, int nSpaces) Format the faulty source code line and point to the error.
protected String	formatSubdiagnostic(JCDiagnostic parent, JCDiagnostic sub, Locale l) Format a subdiagnostics attached to a given diagnostic.
protected List<String>	formatSubdiagnostics(JCDiagnostic d, Locale l) Format all the subdiagnostics attached to a given diagnostic.
AbstractDiagnosticFormatter.SimpleConfiguration	getConfiguration() Get a list of all the enabled verbosity options.
Printer	getPrinter()
protected String	indent(String s, int nSpaces) Indent a string by prepending a given amount of empty spaces to each line of the string.
protected String	indentString(int nSpaces) Creates a string with a given amount of empty spaces.
boolean	isRaw()
protected String	localize(Locale l, String key, Object... args) Converts a String into a locale-dependent representation accordingly to a given locale.
void	setPrinter(Printer printer)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.sun.tools.javac.api.DiagnosticFormatter

formatMessage

Field Detail

messages

protected JavacMessages messages

JavacMessages object used by this formatter for i18n.

depth

protected int depth

Current depth level of the disgnostic being formatted (!= 0 for subdiagnostics)

printer

protected Printer printer

An enhanced printer for formatting types/symbols used by AbstractDiagnosticFormatter. Provides alternate numbering of captured types (they are numbered starting from 1 on each new diagnostic, instead of relying on the underlying hashcode() method which generates unstable output). Also detects cycles in wildcard messages (e.g. if the wildcard type referred by a given captured type C contains C itself) which might lead to infinite loops.

Constructor Detail

AbstractDiagnosticFormatter

protected AbstractDiagnosticFormatter(JavacMessages messages,
                                      AbstractDiagnosticFormatter.SimpleConfiguration config)

Initialize an AbstractDiagnosticFormatter by setting its JavacMessages object.

Parameters:

messages -

Method Detail

formatKind

public String formatKind(JCDiagnostic d,
                         Locale l)

Description copied from interface: DiagnosticFormatter

Controls the way in which a diagnostic kind is displayed.

Specified by:

formatKind in interface DiagnosticFormatter<JCDiagnostic>

Parameters:

d - diagnostic to be formatted

l - locale object to be used for i18n

Returns:

string representation of the diagnostic prefix

format

public String format(JCDiagnostic d,
                     Locale locale)

Description copied from interface: DiagnosticFormatter

Format the contents of a diagnostics.

Specified by:

format in interface DiagnosticFormatter<JCDiagnostic>

Parameters:

d - the diagnostic to be formatted

locale - locale object to be used for i18n

Returns:

a string representing the diagnostic

formatDiagnostic

protected abstract String formatDiagnostic(JCDiagnostic d,
                                           Locale locale)

formatPosition

public String formatPosition(JCDiagnostic d,
                             DiagnosticFormatter.PositionKind pk,
                             Locale l)

Description copied from interface: DiagnosticFormatter

Controls the way in which a diagnostic position is displayed.

Specified by:

formatPosition in interface DiagnosticFormatter<JCDiagnostic>

Parameters:

d - diagnostic to be formatted

pk - enum constant representing the position kind

l - locale object to be used for i18n

Returns:

string representation of the diagnostic position

formatSource

public String formatSource(JCDiagnostic d,
                           boolean fullname,
                           Locale l)

Description copied from interface: DiagnosticFormatter

Controls the way in which a diagnostic source is displayed.

Specified by:

formatSource in interface DiagnosticFormatter<JCDiagnostic>

Parameters:

d - diagnostic to be formatted

fullname - whether the source fullname should be printed

l - locale object to be used for i18n

Returns:

string representation of the diagnostic source

formatArguments

protected Collection<String> formatArguments(JCDiagnostic d,
                                             Locale l)

Format the arguments of a given diagnostic.

Parameters:

d - diagnostic whose arguments are to be formatted

l - locale object to be used for i18n

Returns:

a Collection whose elements are the formatted arguments of the diagnostic

formatArgument

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

Format a single argument of a given diagnostic.

Parameters:

d - 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

formatIterable

protected String formatIterable(JCDiagnostic d,
                                Iterable<?> it,
                                Locale l)

Format an iterable argument of a given diagnostic.

Parameters:

d - diagnostic whose argument is to be formatted

it - iterable argument to be formatted

l - locale object to be used for i18n

Returns:

string representation of the diagnostic iterable argument

formatSubdiagnostics

protected List<String> formatSubdiagnostics(JCDiagnostic d,
                                            Locale l)

Format all the subdiagnostics attached to a given diagnostic.

Parameters:

d - diagnostic whose subdiagnostics are to be formatted

l - locale object to be used for i18n

Returns:

list of all string representations of the subdiagnostics

formatSubdiagnostic

protected String formatSubdiagnostic(JCDiagnostic parent,
                                     JCDiagnostic sub,
                                     Locale l)

Format a subdiagnostics attached to a given diagnostic.

Parameters:

parent - multiline diagnostic whose subdiagnostics is to be formatted

sub - subdiagnostic to be formatted

l - locale object to be used for i18n

Returns:

string representation of the subdiagnostics

formatSourceLine

protected String formatSourceLine(JCDiagnostic d,
                                  int nSpaces)

Format the faulty source code line and point to the error.

Parameters:

d - The diagnostic for which the error line should be printed

formatLintCategory

protected String formatLintCategory(JCDiagnostic d,
                                    Locale l)

localize

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

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

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

displaySource

public boolean displaySource(JCDiagnostic d)

Description copied from interface: DiagnosticFormatter

Whether the source code output for this diagnostic is to be displayed.

Specified by:

displaySource in interface DiagnosticFormatter<JCDiagnostic>

Parameters:

d - diagnostic to be formatted

Returns:

true if the source line this diagnostic refers to is to be displayed

isRaw

public boolean isRaw()

indentString

protected String indentString(int nSpaces)

Creates a string with a given amount of empty spaces. Useful for indenting the text of a diagnostic message.

Parameters:

nSpaces - the amount of spaces to be added to the result string

Returns:

the indentation string

indent

protected String indent(String s,
                        int nSpaces)

Indent a string by prepending a given amount of empty spaces to each line of the string.

Parameters:

s - the string to be indented

nSpaces - the amount of spaces that should be prepended to each line of the string

Returns:

an indented string

getConfiguration

public AbstractDiagnosticFormatter.SimpleConfiguration getConfiguration()

Description copied from interface: DiagnosticFormatter

Get a list of all the enabled verbosity options.

Specified by:

getConfiguration in interface DiagnosticFormatter<JCDiagnostic>

Returns:

verbosity options

getPrinter

public Printer getPrinter()

setPrinter

public void setPrinter(Printer printer)