Package com.sun.tools.javac.util

Class RichDiagnosticFormatter

java.lang.Object

com.sun.tools.javac.util.ForwardingDiagnosticFormatter<JCDiagnostic,AbstractDiagnosticFormatter>

com.sun.tools.javac.util.RichDiagnosticFormatter

All Implemented Interfaces:

DiagnosticFormatter<JCDiagnostic>

public class RichDiagnosticFormatter
extends ForwardingDiagnosticFormatter<JCDiagnostic,AbstractDiagnosticFormatter>

A rich diagnostic formatter is a formatter that provides better integration with javac's type system. A diagostic is first preprocessed in order to keep track of each types/symbols in it; after these informations are collected, the diagnostic is rendered using a standard formatter, whose type/symbol printer has been replaced by a more refined version provided by this rich formatter. The rich formatter currently enables three different features: (i) simple class names - that is class names are displayed used a non qualified name (thus omitting package info) whenever possible - (ii) where clause list - a list of additional subdiagnostics that provide specific info about type-variables, captured types, intersection types that occur in the diagnostic that is to be formatted and (iii) type-variable disambiguation - when the diagnostic refers to two different type-variables with the same name, their representation is disambiguated by appending an index to the type variable name.

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
protected class	RichDiagnosticFormatter.ClassNameSimplifier A name simplifier keeps track of class names usages in order to determine whether a class name can be compacted or not.
static class	RichDiagnosticFormatter.RichConfiguration Configuration object provided by the rich formatter.
protected class	RichDiagnosticFormatter.RichPrinter Enhanced type/symbol printer that provides support for features like simple names and type variable disambiguation.

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

ForwardingDiagnosticFormatter.ForwardingConfiguration

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 RichDiagnosticFormatter.ClassNameSimplifier	nameSimplifier
protected Types.DefaultSymbolVisitor<Void,Void>	symbolPreprocessor
protected Types.UnaryVisitor<Void>	typePreprocessor

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

configuration, formatter

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RichDiagnosticFormatter(Context context)

Method Summary

Modifier and Type	Method and Description
String	format(JCDiagnostic diag, Locale l) Format the contents of a diagnostics.
String	formatMessage(JCDiagnostic diag, Locale l) Controls the way in which a diagnostic message is displayed.
RichDiagnosticFormatter.RichConfiguration	getConfiguration() Get a list of all the enabled verbosity options.
protected RichDiagnosticFormatter.RichPrinter	getRichPrinter() Gets the type/symbol printer used by this formatter.
protected List<JCDiagnostic>	getWhereClauses() Build a list of multiline diagnostics containing detailed info about type-variables, captured types, and intersection types
static RichDiagnosticFormatter	instance(Context context) Get the DiagnosticFormatter instance for this context.
protected void	preprocessArgument(Object arg) Preprocess a diagnostic argument.
protected void	preprocessDiagnostic(JCDiagnostic diag) Preprocess a given diagnostic by looking both into its arguments and into its subdiagnostics (if any).
protected void	preprocessSymbol(Symbol s) Preprocess a given symbol looking for (i) additional info (where clauses) to be added to the main diagnostic (ii) names to be compacted
protected void	preprocessType(Type t) Preprocess a given type looking for (i) additional info (where clauses) to be added to the main diagnostic (ii) names to be compacted.
protected void	setRichPrinter(RichDiagnosticFormatter.RichPrinter printer) Sets the type/symbol printer used by this formatter.

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

displaySource, formatKind, formatPosition, formatSource, getDelegatedFormatter

Methods inherited from class java.lang.Object

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

Field Detail

nameSimplifier

protected RichDiagnosticFormatter.ClassNameSimplifier nameSimplifier

typePreprocessor

protected Types.UnaryVisitor<Void> typePreprocessor

symbolPreprocessor

protected Types.DefaultSymbolVisitor<Void,Void> symbolPreprocessor

Constructor Detail

RichDiagnosticFormatter

protected RichDiagnosticFormatter(Context context)

Method Detail

instance

public static RichDiagnosticFormatter instance(Context context)

Get the DiagnosticFormatter instance for this context.

format

public String format(JCDiagnostic diag,
                     Locale l)

Description copied from interface: DiagnosticFormatter

Format the contents of a diagnostics.

Specified by:

format in interface DiagnosticFormatter<JCDiagnostic>

Overrides:

format in class ForwardingDiagnosticFormatter<JCDiagnostic,AbstractDiagnosticFormatter>

Parameters:

diag - the diagnostic to be formatted

l - locale object to be used for i18n

Returns:

a string representing the diagnostic

formatMessage

public String formatMessage(JCDiagnostic diag,
                            Locale l)

Description copied from interface: DiagnosticFormatter

Controls the way in which a diagnostic message is displayed.

Specified by:

formatMessage in interface DiagnosticFormatter<JCDiagnostic>

Overrides:

formatMessage in class ForwardingDiagnosticFormatter<JCDiagnostic,AbstractDiagnosticFormatter>

Parameters:

diag - diagnostic to be formatted

l - locale object to be used for i18n

Returns:

string representation of the diagnostic message

setRichPrinter

protected void setRichPrinter(RichDiagnosticFormatter.RichPrinter printer)

Sets the type/symbol printer used by this formatter.

Parameters:

printer - the rich printer to be set

getRichPrinter

protected RichDiagnosticFormatter.RichPrinter getRichPrinter()

Gets the type/symbol printer used by this formatter.

Returns:

type/symbol rich printer

preprocessDiagnostic

protected void preprocessDiagnostic(JCDiagnostic diag)

Preprocess a given diagnostic by looking both into its arguments and into its subdiagnostics (if any). This preprocessing is responsible for generating info corresponding to features like where clauses, name simplification, etc.

Parameters:

diag - the diagnostic to be preprocessed

preprocessArgument

protected void preprocessArgument(Object arg)

Preprocess a diagnostic argument. A type/symbol argument is preprocessed by specialized type/symbol preprocessors.

Parameters:

arg - the argument to be translated

getWhereClauses

protected List<JCDiagnostic> getWhereClauses()

Build a list of multiline diagnostics containing detailed info about type-variables, captured types, and intersection types

Returns:

where clause list

preprocessType

protected void preprocessType(Type t)

Preprocess a given type looking for (i) additional info (where clauses) to be added to the main diagnostic (ii) names to be compacted.

preprocessSymbol

protected void preprocessSymbol(Symbol s)

Preprocess a given symbol looking for (i) additional info (where clauses) to be added to the main diagnostic (ii) names to be compacted

getConfiguration

public RichDiagnosticFormatter.RichConfiguration 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 ForwardingDiagnosticFormatter<JCDiagnostic,AbstractDiagnosticFormatter>

Returns:

verbosity options