APIdia Launch Partner
Top Description Inners Fields Constructors Methods
com.sun.tools.javac.util

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

extends Object
implements DiagnosticFormatter<D extends Diagnostic<?>>
Class Inheritance
All Implemented Interfaces
com.sun.tools.javac.api.DiagnosticFormatter
Known Direct Subclasses
com.sun.tools.javac.util.RichDiagnosticFormatter
Imports
java.util.Set, .Locale, javax.tools.Diagnostic, com.sun.tools.javac.api.DiagnosticFormatter, .DiagnosticFormatter.Configuration, .DiagnosticFormatter.Configuration.DiagnosticPart, .DiagnosticFormatter.Configuration.MultilineLimit, .DiagnosticFormatter.PositionKind

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 and Inner Type Summary

Modifier and TypeClass and Description
public static class
ForwardingDiagnosticFormatter.ForwardingConfiguration

A delegated formatter configuration delegates all configurations settings to an underlying configuration object (aka the delegated configuration).

Field Summary

Modifier and TypeField and Description
protected ForwardingDiagnosticFormatter.ForwardingConfiguration
protected F
formatter

The delegated formatter

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public boolean
displaySource(D diag)

Implements com.sun.tools.javac.api.DiagnosticFormatter.displaySource.

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

public String
format(D diag, Locale l)

Implements com.sun.tools.javac.api.DiagnosticFormatter.format.

Format the contents of a diagnostics.

public String
formatKind(D diag, Locale l)

Implements com.sun.tools.javac.api.DiagnosticFormatter.formatKind.

Controls the way in which a diagnostic kind is displayed.

public String
formatMessage(D diag, Locale l)

Implements com.sun.tools.javac.api.DiagnosticFormatter.formatMessage.

Controls the way in which a diagnostic message is displayed.

public String
formatPosition(D diag, DiagnosticFormatter.PositionKind pk, Locale l)

Implements com.sun.tools.javac.api.DiagnosticFormatter.formatPosition.

Controls the way in which a diagnostic position is displayed.

public String
formatSource(D diag, boolean fullname, Locale l)

Implements com.sun.tools.javac.api.DiagnosticFormatter.formatSource.

Controls the way in which a diagnostic source is displayed.

public DiagnosticFormatter.Configuration
getConfiguration()

Implements com.sun.tools.javac.api.DiagnosticFormatter.getConfiguration.

Get a list of all the enabled verbosity options.

public F

Returns:

delegate formatter
getDelegatedFormatter
()

Returns the underlying delegated formatter

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

configurationback to summary
protected ForwardingDiagnosticFormatter.ForwardingConfiguration configuration
formatterback to summary
protected F formatter

The delegated formatter

Constructor Detail

ForwardingDiagnosticFormatterback to summary
public ForwardingDiagnosticFormatter(F formatter)

Method Detail

displaySourceback to summary
public boolean displaySource(D diag)

Implements com.sun.tools.javac.api.DiagnosticFormatter.displaySource.

Doc from com.sun.tools.javac.api.DiagnosticFormatter.displaySource.

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

formatback to summary
public String format(D diag, Locale l)

Implements com.sun.tools.javac.api.DiagnosticFormatter.format.

Doc from com.sun.tools.javac.api.DiagnosticFormatter.format.

Format the contents of a diagnostics.

formatKindback to summary
public String formatKind(D diag, Locale l)

Implements com.sun.tools.javac.api.DiagnosticFormatter.formatKind.

Doc from com.sun.tools.javac.api.DiagnosticFormatter.formatKind.

Controls the way in which a diagnostic kind is displayed.

formatMessageback to summary
public String formatMessage(D diag, Locale l)

Implements com.sun.tools.javac.api.DiagnosticFormatter.formatMessage.

Doc from com.sun.tools.javac.api.DiagnosticFormatter.formatMessage.

Controls the way in which a diagnostic message is displayed.

formatPositionback to summary
public String formatPosition(D diag, DiagnosticFormatter.PositionKind pk, Locale l)

Implements com.sun.tools.javac.api.DiagnosticFormatter.formatPosition.

Doc from com.sun.tools.javac.api.DiagnosticFormatter.formatPosition.

Controls the way in which a diagnostic position is displayed.

formatSourceback to summary
public String formatSource(D diag, boolean fullname, Locale l)

Implements com.sun.tools.javac.api.DiagnosticFormatter.formatSource.

Doc from com.sun.tools.javac.api.DiagnosticFormatter.formatSource.

Controls the way in which a diagnostic source is displayed.

getConfigurationback to summary
public DiagnosticFormatter.Configuration getConfiguration()

Implements com.sun.tools.javac.api.DiagnosticFormatter.getConfiguration.

Doc from com.sun.tools.javac.api.DiagnosticFormatter.getConfiguration.

Get a list of all the enabled verbosity options.

getDelegatedFormatterback to summary
public F getDelegatedFormatter()

Returns the underlying delegated formatter

Returns:F

delegate formatter

com.sun.tools.javac.util back to summary

public Class ForwardingDiagnosticFormatter.ForwardingConfiguration

extends Object
implements Configuration
Class Inheritance
  • java.lang.Object
  • com.sun.tools.javac.util.ForwardingDiagnosticFormatter.ForwardingConfiguration
All Implemented Interfaces
com.sun.tools.javac.api.DiagnosticFormatter.Configuration
Known Direct Subclasses
com.sun.tools.javac.util.RichDiagnosticFormatter.RichConfiguration

A delegated formatter configuration delegates all configurations settings to an underlying configuration object (aka the delegated configuration).

Field Summary

Modifier and TypeField and Description
protected DiagnosticFormatter.Configuration
configuration

The configuration object to which the forwarding configuration delegates some settings

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public DiagnosticFormatter.Configuration

Returns:

delegated configuration
getDelegatedConfiguration
()

Returns the underlying delegated configuration.

public int
public Set<DiagnosticFormatter.Configuration.DiagnosticPart>
getVisible()

Implements com.sun.tools.javac.api.DiagnosticFormatter.Configuration.getVisible.

Retrieve the set of diagnostic parts that should be displayed by the formatter.

public void
public void
setVisible(Set<DiagnosticFormatter.Configuration.DiagnosticPart> diagParts)

Implements com.sun.tools.javac.api.DiagnosticFormatter.Configuration.setVisible.

Configure the set of diagnostic parts that should be displayed by the formatter.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

configurationback to summary
protected DiagnosticFormatter.Configuration configuration

The configuration object to which the forwarding configuration delegates some settings

Constructor Detail

ForwardingConfigurationback to summary
public ForwardingConfiguration(DiagnosticFormatter.Configuration configuration)

Method Detail

getDelegatedConfigurationback to summary
public DiagnosticFormatter.Configuration getDelegatedConfiguration()

Returns the underlying delegated configuration.

Returns:DiagnosticFormatter.Configuration

delegated configuration

getMultilineLimitback to summary
public int getMultilineLimit(DiagnosticFormatter.Configuration.MultilineLimit limit)

Implements com.sun.tools.javac.api.DiagnosticFormatter.Configuration.getMultilineLimit.

Doc from com.sun.tools.javac.api.DiagnosticFormatter.Configuration.getMultilineLimit.

Get a multiline diagnostic limit.

getVisibleback to summary
public Set<DiagnosticFormatter.Configuration.DiagnosticPart> getVisible()

Implements com.sun.tools.javac.api.DiagnosticFormatter.Configuration.getVisible.

Doc from com.sun.tools.javac.api.DiagnosticFormatter.Configuration.getVisible.

Retrieve the set of diagnostic parts that should be displayed by the formatter.

setMultilineLimitback to summary
public void setMultilineLimit(DiagnosticFormatter.Configuration.MultilineLimit limit, int value)

Implements com.sun.tools.javac.api.DiagnosticFormatter.Configuration.setMultilineLimit.

Doc from com.sun.tools.javac.api.DiagnosticFormatter.Configuration.setMultilineLimit.

Set a limit for multiline diagnostics.

Note

Setting a limit has no effect if multiline diagnostics are either fully enabled or disabled.

setVisibleback to summary
public void setVisible(Set<DiagnosticFormatter.Configuration.DiagnosticPart> diagParts)

Implements com.sun.tools.javac.api.DiagnosticFormatter.Configuration.setVisible.

Doc from com.sun.tools.javac.api.DiagnosticFormatter.Configuration.setVisible.

Configure the set of diagnostic parts that should be displayed by the formatter.