Package com.sun.tools.javac.util

Class JCDiagnostic

java.lang.Object

com.sun.tools.javac.util.JCDiagnostic

All Implemented Interfaces:

Diagnostic<JavaFileObject>

Direct Known Subclasses:

JCDiagnostic.MultilineDiagnostic

public class JCDiagnostic
extends Object
implements Diagnostic<JavaFileObject>

An abstraction of a diagnostic message generated by the compiler.

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	JCDiagnostic.DiagnosticFlag
static interface	JCDiagnostic.DiagnosticPosition A DiagnosticPosition provides information about the positions in a file that gave rise to a diagnostic.
static class	JCDiagnostic.DiagnosticType A DiagnosticType defines the type of the diagnostic.
static class	JCDiagnostic.Factory A factory for creating diagnostic objects.
static class	JCDiagnostic.MultilineDiagnostic
static class	JCDiagnostic.SimpleDiagnosticPosition A DiagnosticPosition that simply identifies a position, but no related tree node, as the location for a diagnostic.

Nested classes/interfaces inherited from interface javax.tools.Diagnostic

Diagnostic.Kind

Field Summary

Fields

Modifier and Type	Field and Description
protected Object[]	args

Fields inherited from interface javax.tools.Diagnostic

NOPOS

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	JCDiagnostic(DiagnosticFormatter<JCDiagnostic> formatter, JCDiagnostic.DiagnosticType dt, Lint.LintCategory lc, Set<JCDiagnostic.DiagnosticFlag> flags, DiagnosticSource source, JCDiagnostic.DiagnosticPosition pos, String key, Object... args) Create a diagnostic object.

Method Summary

Modifier and Type	Method and Description
static JCDiagnostic	fragment(String key, Object... args) Deprecated.
Object[]	getArgs() Get the arguments to be included in the text of the diagnostic.
String	getCode()
long	getColumnNumber() Get the column number within the line of source referred to by this diagnostic.
JCDiagnostic.DiagnosticPosition	getDiagnosticPosition()
DiagnosticSource	getDiagnosticSource() Get the source referred to by this diagnostic.
long	getEndPosition()
static DiagnosticFormatter<JCDiagnostic>	getFragmentFormatter() Deprecated.
protected int	getIntEndPosition()
protected int	getIntPosition()
protected int	getIntStartPosition()
Diagnostic.Kind	getKind()
long	getLineNumber() Get the line number within the source referred to by this diagnostic.
Lint.LintCategory	getLintCategory() Get the associated lint category, or null if none.
String	getMessage(Locale locale)
long	getPosition()
String	getPrefix() Get the prefix string associated with this type of diagnostic.
String	getPrefix(JCDiagnostic.DiagnosticType dt) Get the prefix string associated with a particular type of diagnostic.
JavaFileObject	getSource() Get the name of the source file referred to by this diagnostic.
long	getStartPosition()
List<JCDiagnostic>	getSubdiagnostics() Get the subdiagnostic list
JCDiagnostic.DiagnosticType	getType() Get the type of this diagnostic.
boolean	hasLintCategory() Check whether this diagnostic has an associated lint category.
boolean	isFlagSet(JCDiagnostic.DiagnosticFlag flag)
boolean	isMandatory() Check whether or not this diagnostic is required to be shown.
boolean	isMultiline()
void	setFlag(JCDiagnostic.DiagnosticFlag flag)
String	toString() Return the standard presentation of this diagnostic.

Methods inherited from class java.lang.Object

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

Field Detail

args

protected final Object[] args

Constructor Detail

JCDiagnostic

protected JCDiagnostic(DiagnosticFormatter<JCDiagnostic> formatter,
                       JCDiagnostic.DiagnosticType dt,
                       Lint.LintCategory lc,
                       Set<JCDiagnostic.DiagnosticFlag> flags,
                       DiagnosticSource source,
                       JCDiagnostic.DiagnosticPosition pos,
                       String key,
                       Object... args)

Create a diagnostic object.

Parameters:

formatter - the formatter to use for the diagnostic

dt - the type of diagnostic

lc - the lint category for the diagnostic

source - the name of the source file, or null if none.

pos - the character offset within the source file, if given.

key - a resource key to identify the text of the diagnostic

args - arguments to be included in the text of the diagnostic

Method Detail

fragment

@Deprecated
public static JCDiagnostic fragment(String key,
                                    Object... args)

Deprecated.

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

Parameters:

key - The key for the localized error message.

args - Fields of the error message.

getFragmentFormatter

@Deprecated
public static DiagnosticFormatter<JCDiagnostic> getFragmentFormatter()

Deprecated.

getType

public JCDiagnostic.DiagnosticType getType()

Get the type of this diagnostic.

Returns:

the type of this diagnostic

getSubdiagnostics

public List<JCDiagnostic> getSubdiagnostics()

Get the subdiagnostic list

Returns:

subdiagnostic list

isMultiline

public boolean isMultiline()

isMandatory

public boolean isMandatory()

Check whether or not this diagnostic is required to be shown.

Returns:

true if this diagnostic is required to be shown.

hasLintCategory

public boolean hasLintCategory()

Check whether this diagnostic has an associated lint category.

getLintCategory

public Lint.LintCategory getLintCategory()

Get the associated lint category, or null if none.

getSource

public JavaFileObject getSource()

Get the name of the source file referred to by this diagnostic.

Specified by:

getSource in interface Diagnostic<JavaFileObject>

Returns:

the name of the source referred to with this diagnostic, or null if none

getDiagnosticSource

public DiagnosticSource getDiagnosticSource()

Get the source referred to by this diagnostic.

Returns:

the source referred to with this diagnostic, or null if none

getIntStartPosition

protected int getIntStartPosition()

getIntPosition

protected int getIntPosition()

getIntEndPosition

protected int getIntEndPosition()

getStartPosition

public long getStartPosition()

Specified by:

getStartPosition in interface Diagnostic<JavaFileObject>

getPosition

public long getPosition()

Specified by:

getPosition in interface Diagnostic<JavaFileObject>

getEndPosition

public long getEndPosition()

Specified by:

getEndPosition in interface Diagnostic<JavaFileObject>

getDiagnosticPosition

public JCDiagnostic.DiagnosticPosition getDiagnosticPosition()

getLineNumber

public long getLineNumber()

Get the line number within the source referred to by this diagnostic.

Specified by:

getLineNumber in interface Diagnostic<JavaFileObject>

Returns:

the line number within the source referred to by this diagnostic

getColumnNumber

public long getColumnNumber()

Get the column number within the line of source referred to by this diagnostic.

Specified by:

getColumnNumber in interface Diagnostic<JavaFileObject>

Returns:

the column number within the line of source referred to by this diagnostic

getArgs

public Object[] getArgs()

Get the arguments to be included in the text of the diagnostic.

Returns:

the arguments to be included in the text of the diagnostic

getPrefix

public String getPrefix()

Get the prefix string associated with this type of diagnostic.

Returns:

the prefix string associated with this type of diagnostic

getPrefix

public String getPrefix(JCDiagnostic.DiagnosticType dt)

Get the prefix string associated with a particular type of diagnostic.

Returns:

the prefix string associated with a particular type of diagnostic

toString

public String toString()

Return the standard presentation of this diagnostic.

Overrides:

toString in class Object

getKind

public Diagnostic.Kind getKind()

Specified by:

getKind in interface Diagnostic<JavaFileObject>

getCode

public String getCode()

Specified by:

getCode in interface Diagnostic<JavaFileObject>

getMessage

public String getMessage(Locale locale)

Specified by:

getMessage in interface Diagnostic<JavaFileObject>

setFlag

public void setFlag(JCDiagnostic.DiagnosticFlag flag)

isFlagSet

public boolean isFlagSet(JCDiagnostic.DiagnosticFlag flag)