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 java.lang.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.

  Nested Class Summary

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

  DiagnosticFormatter.PositionKind

  Field Summary

  protected JavacMessages	messages JavacMessages object used by this formatter for i18n
  protected boolean	showSource

  Constructor Summary

  protected	AbstractDiagnosticFormatter(JavacMessages messages, boolean showSource)
  protected	AbstractDiagnosticFormatter(JavacMessages messages, Options options, boolean showSource) Initialize an AbstractDiagnosticFormatter by setting its JavacMessages object

  Method Summary

  boolean	displaySource(JCDiagnostic d) Whether the source code output for this diagnostic is to be displayed
  protected java.lang.String	formatArgument(JCDiagnostic d, java.lang.Object arg, java.util.Locale l) Format a single argument of a given diagnostic.
  protected java.util.Collection<java.lang.String>	formatArguments(JCDiagnostic d, java.util.Locale l) Format the arguments of a given diagnostic.
  protected java.lang.String	formatIterable(JCDiagnostic d, java.lang.Iterable<?> it, java.util.Locale l) Format an iterable argument of a given diagnostic.
  java.lang.String	formatKind(JCDiagnostic d, java.util.Locale l) Controls the way in which a diagnostic kind is displayed.
  java.lang.String	formatMessage(JCDiagnostic d, java.util.Locale l) Controls the way in which a diagnostic message is displayed.
  java.lang.String	formatPosition(JCDiagnostic d, DiagnosticFormatter.PositionKind pk, java.util.Locale l) Controls the way in which a diagnostic position is displayed.
  java.lang.String	formatSource(JCDiagnostic d, boolean fullname, java.util.Locale l) Controls the way in which a diagnostic source is displayed.
  protected java.lang.String	formatSourceLine(JCDiagnostic d) Format the faulty source code line and point to the error.
  protected java.lang.String	formatSubdiagnostics(JCDiagnostic d, java.util.Locale l) Format all the subdiagnostics attached to a given diagnostic
  long	getPosition(JCDiagnostic d, DiagnosticFormatter.PositionKind pk)
  protected java.lang.String	indent(java.lang.String s, int nSpaces) Indent a string by prepending a given amount of empty spaces to each line of the string
  protected java.lang.String	indentString(int nSpaces) Creates a string with a given amount of empty spaces.
  protected java.lang.String	localize(java.util.Locale l, java.lang.String key, java.lang.Object... args) Converts a String into a locale-dependent representation accordingly to a given locale

  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

  format

  Field Detail

  messages

  protected JavacMessages messages

  JavacMessages object used by this formatter for i18n

  showSource

  protected boolean showSource

  Constructor Detail

  AbstractDiagnosticFormatter

  protected AbstractDiagnosticFormatter(JavacMessages messages,
                                        Options options,
                                        boolean showSource)

  Initialize an AbstractDiagnosticFormatter by setting its JavacMessages object

  Parameters:

  messages -

  AbstractDiagnosticFormatter

  protected AbstractDiagnosticFormatter(JavacMessages messages,
                                        boolean showSource)

  Method Detail

  formatMessage

  public java.lang.String formatMessage(JCDiagnostic d,
                                        java.util.Locale l)

  Description copied from interface: DiagnosticFormatter

  Controls the way in which a diagnostic message is displayed.

  Specified by:

  formatMessage in interface DiagnosticFormatter<JCDiagnostic>

  Parameters:

  d - diagnostic to be formatted

  l - locale object to be used for i18n

  Returns:

  string representation of the diagnostic message

  formatKind

  public java.lang.String formatKind(JCDiagnostic d,
                                     java.util.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

  formatPosition

  public java.lang.String formatPosition(JCDiagnostic d,
                                         DiagnosticFormatter.PositionKind pk,
                                         java.util.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

  getPosition

  public long getPosition(JCDiagnostic d,
                          DiagnosticFormatter.PositionKind pk)

  formatSource

  public java.lang.String formatSource(JCDiagnostic d,
                                       boolean fullname,
                                       java.util.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 java.util.Collection<java.lang.String> formatArguments(JCDiagnostic d,
                                                                   java.util.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 java.lang.String formatArgument(JCDiagnostic d,
                                            java.lang.Object arg,
                                            java.util.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 java.lang.String formatIterable(JCDiagnostic d,
                                            java.lang.Iterable<?> it,
                                            java.util.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 java.lang.String formatSubdiagnostics(JCDiagnostic d,
                                                  java.util.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:

  string representation of the subdiagnostics

  formatSourceLine

  protected java.lang.String formatSourceLine(JCDiagnostic d)

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

  Parameters:

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

  localize

  protected java.lang.String localize(java.util.Locale l,
                                      java.lang.String key,
                                      java.lang.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

  indentString

  protected java.lang.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 java.lang.String indent(java.lang.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