Package com.sun.tools.javac.util

Class JCDiagnostic.Factory

java.lang.Object

com.sun.tools.javac.util.JCDiagnostic.Factory

Enclosing class:

JCDiagnostic

public static class JCDiagnostic.Factory
extends Object

A factory for creating diagnostic objects.

Field Summary

Fields

Modifier and Type	Field and Description
protected static Context.Key<JCDiagnostic.Factory>	diagnosticFactoryKey The context key for the diagnostic factory.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Factory(Context context) Create a new diagnostic factory.
	Factory(JavacMessages messages, String prefix) Create a new diagnostic factory.

Method Summary

Modifier and Type	Method and Description
JCDiagnostic	create(JCDiagnostic.DiagnosticType kind, DiagnosticSource source, JCDiagnostic.DiagnosticPosition pos, String key, Object... args) Create a new diagnostic of the given kind, which is not mandatory and which has no lint category.
JCDiagnostic	create(JCDiagnostic.DiagnosticType kind, Lint.LintCategory lc, Set<JCDiagnostic.DiagnosticFlag> flags, DiagnosticSource source, JCDiagnostic.DiagnosticPosition pos, String key, Object... args) Create a new diagnostic of the given kind.
JCDiagnostic	error(DiagnosticSource source, JCDiagnostic.DiagnosticPosition pos, String key, Object... args) Create an error diagnostic.
JCDiagnostic	fragment(String key, Object... args) Create a fragment diagnostic, for use as an argument in other diagnostics
static JCDiagnostic.Factory	instance(Context context) Get the Factory instance for this context.
JCDiagnostic	mandatoryNote(DiagnosticSource source, String key, Object... args) Create a note diagnostic that will not be hidden by the -nowarn or -Xlint:none options.
JCDiagnostic	mandatoryWarning(DiagnosticSource source, JCDiagnostic.DiagnosticPosition pos, String key, Object... args) Create a warning diagnostic that will not be hidden by the -nowarn or -Xlint:none options.
JCDiagnostic	mandatoryWarning(Lint.LintCategory lc, DiagnosticSource source, JCDiagnostic.DiagnosticPosition pos, String key, Object... args) Create a warning diagnostic that will not be hidden by the -nowarn or -Xlint:none options.
JCDiagnostic	note(DiagnosticSource source, JCDiagnostic.DiagnosticPosition pos, String key, Object... args) Create a note diagnostic.
JCDiagnostic	note(String key, Object... args) Create a note diagnostic.
protected String	qualify(JCDiagnostic.DiagnosticType t, String key)
JCDiagnostic	warning(DiagnosticSource source, JCDiagnostic.DiagnosticPosition pos, String key, Object... args) Create a warning diagnostic.
JCDiagnostic	warning(Lint.LintCategory lc, DiagnosticSource source, JCDiagnostic.DiagnosticPosition pos, String key, Object... args) Create a warning diagnostic.
JCDiagnostic	warning(Lint.LintCategory lc, String key, Object... args) Create a warning diagnostic.

Methods inherited from class java.lang.Object

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

Field Detail

diagnosticFactoryKey

protected static final Context.Key<JCDiagnostic.Factory> diagnosticFactoryKey

The context key for the diagnostic factory.

Constructor Detail

Factory

protected Factory(Context context)

Create a new diagnostic factory.

Factory

public Factory(JavacMessages messages,
               String prefix)

Create a new diagnostic factory.

Method Detail

instance

public static JCDiagnostic.Factory instance(Context context)

Get the Factory instance for this context.

error

public JCDiagnostic error(DiagnosticSource source,
                          JCDiagnostic.DiagnosticPosition pos,
                          String key,
                          Object... args)

Create an error diagnostic.

Parameters:

source - The source of the compilation unit, if any, in which to report the error.

pos - The source position at which to report the error.

key - The key for the localized error message.

args - Fields of the error message.

mandatoryWarning

public JCDiagnostic mandatoryWarning(DiagnosticSource source,
                                     JCDiagnostic.DiagnosticPosition pos,
                                     String key,
                                     Object... args)

Create a warning diagnostic that will not be hidden by the -nowarn or -Xlint:none options.

Parameters:

source - The source of the compilation unit, if any, in which to report the warning.

pos - The source position at which to report the warning.

key - The key for the localized warning message.

args - Fields of the warning message.

See Also:

MandatoryWarningHandler

mandatoryWarning

public JCDiagnostic mandatoryWarning(Lint.LintCategory lc,
                                     DiagnosticSource source,
                                     JCDiagnostic.DiagnosticPosition pos,
                                     String key,
                                     Object... args)

Create a warning diagnostic that will not be hidden by the -nowarn or -Xlint:none options.

Parameters:

lc - The lint category for the diagnostic

source - The source of the compilation unit, if any, in which to report the warning.

pos - The source position at which to report the warning.

key - The key for the localized warning message.

args - Fields of the warning message.

See Also:

MandatoryWarningHandler

warning

public JCDiagnostic warning(Lint.LintCategory lc,
                            String key,
                            Object... args)

Create a warning diagnostic.

Parameters:

lc - The lint category for the diagnostic

key - The key for the localized error message.

args - Fields of the warning message.

See Also:

MandatoryWarningHandler

warning

public JCDiagnostic warning(DiagnosticSource source,
                            JCDiagnostic.DiagnosticPosition pos,
                            String key,
                            Object... args)

Create a warning diagnostic.

Parameters:

source - The source of the compilation unit, if any, in which to report the warning.

pos - The source position at which to report the warning.

key - The key for the localized warning message.

args - Fields of the warning message.

warning

public JCDiagnostic warning(Lint.LintCategory lc,
                            DiagnosticSource source,
                            JCDiagnostic.DiagnosticPosition pos,
                            String key,
                            Object... args)

Create a warning diagnostic.

Parameters:

lc - The lint category for the diagnostic

source - The source of the compilation unit, if any, in which to report the warning.

pos - The source position at which to report the warning.

key - The key for the localized warning message.

args - Fields of the warning message.

See Also:

MandatoryWarningHandler

mandatoryNote

public JCDiagnostic mandatoryNote(DiagnosticSource source,
                                  String key,
                                  Object... args)

Create a note diagnostic that will not be hidden by the -nowarn or -Xlint:none options.

Parameters:

key - The key for the localized message.

args - Fields of the message.

See Also:

MandatoryWarningHandler

note

public JCDiagnostic note(String key,
                         Object... args)

Create a note diagnostic.

Parameters:

key - The key for the localized error message.

args - Fields of the message.

note

public JCDiagnostic note(DiagnosticSource source,
                         JCDiagnostic.DiagnosticPosition pos,
                         String key,
                         Object... args)

Create a note diagnostic.

Parameters:

source - The source of the compilation unit, if any, in which to report the note.

pos - The source position at which to report the note.

key - The key for the localized message.

args - Fields of the message.

fragment

public JCDiagnostic fragment(String key,
                             Object... args)

Create a fragment diagnostic, for use as an argument in other diagnostics

Parameters:

key - The key for the localized message.

args - Fields of the message.

create

public JCDiagnostic create(JCDiagnostic.DiagnosticType kind,
                           DiagnosticSource source,
                           JCDiagnostic.DiagnosticPosition pos,
                           String key,
                           Object... args)

Create a new diagnostic of the given kind, which is not mandatory and which has no lint category.

Parameters:

kind - The diagnostic kind

source - The source of the compilation unit, if any, in which to report the message.

pos - The source position at which to report the message.

key - The key for the localized message.

args - Fields of the message.

create

public JCDiagnostic create(JCDiagnostic.DiagnosticType kind,
                           Lint.LintCategory lc,
                           Set<JCDiagnostic.DiagnosticFlag> flags,
                           DiagnosticSource source,
                           JCDiagnostic.DiagnosticPosition pos,
                           String key,
                           Object... args)

Create a new diagnostic of the given kind.

Parameters:

kind - The diagnostic kind

lc - The lint category, if applicable, or null

flags - The set of flags for the diagnostic

source - The source of the compilation unit, if any, in which to report the message.

pos - The source position at which to report the message.

key - The key for the localized message.

args - Fields of the message.

qualify

protected String qualify(JCDiagnostic.DiagnosticType t,
                         String key)