com.sun.tools.javac.util

Class BasicDiagnosticFormatter

java.lang.Object

com.sun.tools.javac.util.AbstractDiagnosticFormatter

com.sun.tools.javac.util.BasicDiagnosticFormatter

All Implemented Interfaces:

DiagnosticFormatter<JCDiagnostic>

public class BasicDiagnosticFormatter
extends AbstractDiagnosticFormatter

A basic formatter for diagnostic messages. The basic formatter will format a diagnostic according to one of three format patterns, depending on whether or not the source name and position are set. The formatter supports a printf-like string for patterns with the following special characters:

• %b: the base of the source name
• %f: the source name (full absolute path)
• %l: the line number of the diagnostic, derived from the character offset
• %c: the column number of the diagnostic, derived from the character offset
• %o: the character offset of the diagnostic if set
• %p: the prefix for the diagnostic, derived from the diagnostic type
• %t: the prefix as it normally appears in standard diagnostics. In this case, no prefix is shown if the type is ERROR and if a source name is set
• %m: the text or the diagnostic, including any appropriate arguments
• %_: space delimiter, useful for formatting 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

Modifier and Type	Class and Description
static class	BasicDiagnosticFormatter.BasicConfiguration

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
BasicDiagnosticFormatter(JavacMessages msgs) Create a standard basic formatter
BasicDiagnosticFormatter(Options options, JavacMessages msgs) Create a basic formatter based on the supplied options.

Method Summary

Modifier and Type	Method and Description
protected String	addSourceLineIfNeeded(JCDiagnostic d, String msg)
String	formatDiagnostic(JCDiagnostic d, Locale l)
String	formatMessage(JCDiagnostic d, Locale l) Controls the way in which a diagnostic message is displayed.
protected String	formatMeta(char c, JCDiagnostic d, Locale l)
BasicDiagnosticFormatter.BasicConfiguration	getConfiguration() Get a list of all the enabled verbosity options.

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

BasicDiagnosticFormatter

public BasicDiagnosticFormatter(Options options,
                                JavacMessages msgs)

Create a basic formatter based on the supplied options.

Parameters:

options - list of command-line options

msgs - JavacMessages object used for i18n

BasicDiagnosticFormatter

public BasicDiagnosticFormatter(JavacMessages msgs)

Create a standard basic formatter

Parameters:

msgs - JavacMessages object used for i18n

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

addSourceLineIfNeeded

protected String addSourceLineIfNeeded(JCDiagnostic d,
                                       String msg)

formatMeta

protected String formatMeta(char c,
                            JCDiagnostic d,
                            Locale l)

getConfiguration

public BasicDiagnosticFormatter.BasicConfiguration getConfiguration()

Description copied from interface: DiagnosticFormatter

Get a list of all the enabled verbosity options.

Specified by:

getConfiguration in interface DiagnosticFormatter<JCDiagnostic>

Overrides:

getConfiguration in class AbstractDiagnosticFormatter

Returns:

verbosity options