Package com.sun.tools.javac.util

Class ForwardingDiagnosticFormatter<D extends Diagnostic<?>,F extends DiagnosticFormatter<D>>

java.lang.Object

com.sun.tools.javac.util.ForwardingDiagnosticFormatter<D,F>

All Implemented Interfaces:

DiagnosticFormatter<D>

Direct Known Subclasses:

RichDiagnosticFormatter

public class ForwardingDiagnosticFormatter<D extends Diagnostic<?>,F extends DiagnosticFormatter<D>>
extends Object
implements DiagnosticFormatter<D>

A delegated diagnostic formatter delegates all formatting actions to an underlying formatter (aka the delegated formatter).

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	ForwardingDiagnosticFormatter.ForwardingConfiguration A delegated formatter configuration delegates all configurations settings to an underlying configuration object (aka the delegated configuration).

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 ForwardingDiagnosticFormatter.ForwardingConfiguration	configuration
protected F	formatter The delegated formatter

Constructor Summary

Constructors

Constructor and Description
ForwardingDiagnosticFormatter(F formatter)

Method Summary

Modifier and Type	Method and Description
boolean	displaySource(D diag) Whether the source code output for this diagnostic is to be displayed.
String	format(D diag, Locale l) Format the contents of a diagnostics.
String	formatKind(D diag, Locale l) Controls the way in which a diagnostic kind is displayed.
String	formatMessage(D diag, Locale l) Controls the way in which a diagnostic message is displayed.
String	formatPosition(D diag, DiagnosticFormatter.PositionKind pk, Locale l) Controls the way in which a diagnostic position is displayed.
String	formatSource(D diag, boolean fullname, Locale l) Controls the way in which a diagnostic source is displayed.
DiagnosticFormatter.Configuration	getConfiguration() Get a list of all the enabled verbosity options.
F	getDelegatedFormatter() Returns the underlying delegated formatter

Methods inherited from class java.lang.Object

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

Field Detail

formatter

protected F extends DiagnosticFormatter<D> formatter

The delegated formatter

configuration

protected ForwardingDiagnosticFormatter.ForwardingConfiguration configuration

Constructor Detail

ForwardingDiagnosticFormatter

public ForwardingDiagnosticFormatter(F formatter)

Method Detail

getDelegatedFormatter

public F getDelegatedFormatter()

Returns the underlying delegated formatter

Returns:

delegate formatter

getConfiguration

public DiagnosticFormatter.Configuration getConfiguration()

Description copied from interface: DiagnosticFormatter

Get a list of all the enabled verbosity options.

Specified by:

getConfiguration in interface DiagnosticFormatter<D extends Diagnostic<?>>

Returns:

verbosity options

displaySource

public boolean displaySource(D diag)

Description copied from interface: DiagnosticFormatter

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

Specified by:

displaySource in interface DiagnosticFormatter<D extends Diagnostic<?>>

Parameters:

diag - diagnostic to be formatted

Returns:

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

format

public String format(D diag,
                     Locale l)

Description copied from interface: DiagnosticFormatter

Format the contents of a diagnostics.

Specified by:

format in interface DiagnosticFormatter<D extends Diagnostic<?>>

Parameters:

diag - the diagnostic to be formatted

l - locale object to be used for i18n

Returns:

a string representing the diagnostic

formatKind

public String formatKind(D diag,
                         Locale l)

Description copied from interface: DiagnosticFormatter

Controls the way in which a diagnostic kind is displayed.

Specified by:

formatKind in interface DiagnosticFormatter<D extends Diagnostic<?>>

Parameters:

diag - diagnostic to be formatted

l - locale object to be used for i18n

Returns:

string representation of the diagnostic prefix

formatMessage

public String formatMessage(D diag,
                            Locale l)

Description copied from interface: DiagnosticFormatter

Controls the way in which a diagnostic message is displayed.

Specified by:

formatMessage in interface DiagnosticFormatter<D extends Diagnostic<?>>

Parameters:

diag - diagnostic to be formatted

l - locale object to be used for i18n

Returns:

string representation of the diagnostic message

formatPosition

public String formatPosition(D diag,
                             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<D extends Diagnostic<?>>

Parameters:

diag - 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(D diag,
                           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<D extends Diagnostic<?>>

Parameters:

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