Package com.sun.tools.javac.util

Class Log

java.lang.Object

com.sun.tools.javac.util.AbstractLog

com.sun.tools.javac.util.Log

public class Log
extends AbstractLog

A class for error logs. Reports errors and warnings, and keeps track of error numbers and positions.

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	Log.DeferredDiagnosticHandler A DiagnosticHandler that can defer some or all diagnostics, by buffering them for later examination and/or reporting.
static class	Log.DiagnosticHandler DiagnosticHandler's provide the initial handling for diagnostics.
static class	Log.DiscardDiagnosticHandler A DiagnosticHandler that discards all diagnostics.
static class	Log.PrefixKind
static class	Log.WriterKind

Field Summary

Fields

Modifier and Type	Field and Description
boolean	compressedOutput Set to true if a compressed diagnostic is reported
protected DiagnosticListener<? super JavaFileObject>	diagListener Diagnostic listener, if provided through programmatic interface to javac (JSR 199).
boolean	dumpOnError Print stack trace on errors?
boolean	emitWarnings Switch: emit warning messages.
protected PrintWriter	errWriter
Set<String>	expectDiagKeys Keys for expected diagnostics.
static Context.Key<Log>	logKey The context key for the log.
protected int	MaxErrors The maximum number of errors/warnings that are reported.
protected int	MaxWarnings
boolean	multipleErrors Print multiple errors for same source locations.
int	nerrors The number of errors encountered so far.
protected PrintWriter	noticeWriter
int	nwarnings The number of warnings encountered so far.
static Context.Key<PrintWriter>	outKey The context key for the output PrintWriter.
boolean	promptOnError Switch: prompt user on each error.
boolean	suppressNotes Switch: suppress note messages.
protected PrintWriter	warnWriter

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

diags, source, sourceMap

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Log(Context context) Construct a log with default settings.
protected	Log(Context context, PrintWriter defaultWriter) Construct a log with all output redirected.
protected	Log(Context context, PrintWriter errWriter, PrintWriter warnWriter, PrintWriter noticeWriter) Construct a log with given I/O redirections.

Method Summary

Modifier and Type	Method and Description
JavaFileObject	currentSourceFile() Return current sourcefile.
protected void	directError(String key, Object... args)
void	flush() Flush the logs
void	flush(Log.WriterKind kind)
static String	format(String fmt, Object... args)
protected int	getDefaultMaxErrors() Default value for -Xmaxerrs.
protected int	getDefaultMaxWarnings() Default value for -Xmaxwarns.
DiagnosticFormatter<JCDiagnostic>	getDiagnosticFormatter() Get the current diagnostic formatter.
static String	getLocalizedString(String key, Object... args) Find a localized string in the resource bundle.
PrintWriter	getWriter(Log.WriterKind kind)
protected PrintWriter	getWriterForDiagnosticType(JCDiagnostic.DiagnosticType dt) Deprecated.
boolean	hasDiagnosticListener()
void	initRound(Log other) Propagate the previous log's information.
static Log	instance(Context context) Get the Log instance for this context.
String	localize(Log.PrefixKind pk, String key, Object... args) Find a localized string in the resource bundle.
String	localize(String key, Object... args) Find a localized string in the resource bundle.
void	popDiagnosticHandler(Log.DiagnosticHandler h) Replace the specified diagnostic handler with the handler that was current at the time this handler was created.
void	printLines(Log.PrefixKind pk, String key, Object... args)
void	printLines(Log.WriterKind wk, Log.PrefixKind pk, String key, Object... args)
void	printLines(Log.WriterKind wk, String key, Object... args)
void	printLines(String key, Object... args)
void	printNewline()
void	printNewline(Log.WriterKind wk)
void	printRawLines(Log.WriterKind kind, String msg) Print the text of a message, translating newlines appropriately for the platform.
static void	printRawLines(PrintWriter writer, String msg) Print the text of a message, translating newlines appropriately for the platform.
void	printRawLines(String msg) Print the text of a message, translating newlines appropriately for the platform.
void	printVerbose(String key, Object... args) Print the localized text of a "verbose" message to the noticeWriter stream.
void	prompt() Prompt user after an error.
void	rawError(int pos, String msg) report an error:
void	rawWarning(int pos, String msg) report a warning:
void	report(JCDiagnostic diagnostic) Primary method to report a diagnostic.
void	setDiagnosticFormatter(DiagnosticFormatter<JCDiagnostic> diagFormatter) Set the current diagnostic formatter.
void	setEndPosTable(JavaFileObject name, EndPosTable endPosTable)
void	setWriter(Log.WriterKind kind, PrintWriter pw)
void	setWriters(PrintWriter pw)
protected boolean	shouldReport(JavaFileObject file, int pos) Returns true if an error needs to be reported for a given source name and pos.
void	strictWarning(JCDiagnostic.DiagnosticPosition pos, String key, Object... args) Report a warning that cannot be suppressed.
protected void	writeDiagnostic(JCDiagnostic diag) Write out a diagnostic.

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

currentSource, error, error, error, error, error, getSource, mandatoryNote, mandatoryWarning, mandatoryWarning, note, note, note, note, useSource, warning, warning, warning, warning, warning

Methods inherited from class java.lang.Object

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

Field Detail

logKey

public static final Context.Key<Log> logKey

The context key for the log.

outKey

public static final Context.Key<PrintWriter> outKey

The context key for the output PrintWriter.

errWriter

protected PrintWriter errWriter

warnWriter

protected PrintWriter warnWriter

noticeWriter

protected PrintWriter noticeWriter

MaxErrors

protected int MaxErrors

The maximum number of errors/warnings that are reported.

MaxWarnings

protected int MaxWarnings

promptOnError

public boolean promptOnError

Switch: prompt user on each error.

emitWarnings

public boolean emitWarnings

Switch: emit warning messages.

suppressNotes

public boolean suppressNotes

Switch: suppress note messages.

dumpOnError

public boolean dumpOnError

Print stack trace on errors?

multipleErrors

public boolean multipleErrors

Print multiple errors for same source locations.

diagListener

protected DiagnosticListener<? super JavaFileObject> diagListener

Diagnostic listener, if provided through programmatic interface to javac (JSR 199).

expectDiagKeys

public Set<String> expectDiagKeys

Keys for expected diagnostics.

compressedOutput

public boolean compressedOutput

Set to true if a compressed diagnostic is reported

nerrors

public int nerrors

The number of errors encountered so far.

nwarnings

public int nwarnings

The number of warnings encountered so far.

Constructor Detail

Log

protected Log(Context context,
              PrintWriter errWriter,
              PrintWriter warnWriter,
              PrintWriter noticeWriter)

Construct a log with given I/O redirections.

Log

protected Log(Context context)

Construct a log with default settings.

Log

protected Log(Context context,
              PrintWriter defaultWriter)

Construct a log with all output redirected.

Method Detail

getDefaultMaxErrors

protected int getDefaultMaxErrors()

Default value for -Xmaxerrs.

getDefaultMaxWarnings

protected int getDefaultMaxWarnings()

Default value for -Xmaxwarns.

instance

public static Log instance(Context context)

Get the Log instance for this context.

hasDiagnosticListener

public boolean hasDiagnosticListener()

setEndPosTable

public void setEndPosTable(JavaFileObject name,
                           EndPosTable endPosTable)

currentSourceFile

public JavaFileObject currentSourceFile()

Return current sourcefile.

getDiagnosticFormatter

public DiagnosticFormatter<JCDiagnostic> getDiagnosticFormatter()

Get the current diagnostic formatter.

setDiagnosticFormatter

public void setDiagnosticFormatter(DiagnosticFormatter<JCDiagnostic> diagFormatter)

Set the current diagnostic formatter.

getWriter

public PrintWriter getWriter(Log.WriterKind kind)

setWriter

public void setWriter(Log.WriterKind kind,
                      PrintWriter pw)

setWriters

public void setWriters(PrintWriter pw)

initRound

public void initRound(Log other)

Propagate the previous log's information.

popDiagnosticHandler

public void popDiagnosticHandler(Log.DiagnosticHandler h)

Replace the specified diagnostic handler with the handler that was current at the time this handler was created. The given handler must be the currently installed handler; it must be specified explicitly for clarity and consistency checking.

flush

public void flush()

Flush the logs

flush

public void flush(Log.WriterKind kind)

shouldReport

protected boolean shouldReport(JavaFileObject file,
                               int pos)

Returns true if an error needs to be reported for a given source name and pos.

prompt

public void prompt()

Prompt user after an error.

printNewline

public void printNewline()

printNewline

public void printNewline(Log.WriterKind wk)

printLines

public void printLines(String key,
                       Object... args)

printLines

public void printLines(Log.PrefixKind pk,
                       String key,
                       Object... args)

printLines

public void printLines(Log.WriterKind wk,
                       String key,
                       Object... args)

printLines

public void printLines(Log.WriterKind wk,
                       Log.PrefixKind pk,
                       String key,
                       Object... args)

printRawLines

public void printRawLines(String msg)

Print the text of a message, translating newlines appropriately for the platform.

printRawLines

public void printRawLines(Log.WriterKind kind,
                          String msg)

Print the text of a message, translating newlines appropriately for the platform.

printRawLines

public static void printRawLines(PrintWriter writer,
                                 String msg)

Print the text of a message, translating newlines appropriately for the platform.

printVerbose

public void printVerbose(String key,
                         Object... args)

Print the localized text of a "verbose" message to the noticeWriter stream.

directError

protected void directError(String key,
                           Object... args)

Specified by:

directError in class AbstractLog

strictWarning

public void strictWarning(JCDiagnostic.DiagnosticPosition pos,
                          String key,
                          Object... args)

Report a warning that cannot be suppressed.

Parameters:

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

key - The key for the localized warning message.

args - Fields of the warning message.

report

public void report(JCDiagnostic diagnostic)

Primary method to report a diagnostic.

Specified by:

report in class AbstractLog

Parameters:

diagnostic -

writeDiagnostic

protected void writeDiagnostic(JCDiagnostic diag)

Write out a diagnostic.

getWriterForDiagnosticType

@Deprecated
protected PrintWriter getWriterForDiagnosticType(JCDiagnostic.DiagnosticType dt)

Deprecated.

getLocalizedString

public static String getLocalizedString(String key,
                                        Object... args)

Find a localized string in the resource bundle. Because this method is static, it ignores the locale. Use localize(key, args) when possible.

Parameters:

key - The key for the localized string.

args - Fields to substitute into the string.

localize

public String localize(String key,
                       Object... args)

Find a localized string in the resource bundle.

Parameters:

key - The key for the localized string.

args - Fields to substitute into the string.

localize

public String localize(Log.PrefixKind pk,
                       String key,
                       Object... args)

Find a localized string in the resource bundle.

Parameters:

key - The key for the localized string.

args - Fields to substitute into the string.

rawError

public void rawError(int pos,
                     String msg)

report an error:

rawWarning

public void rawWarning(int pos,
                       String msg)

report a warning:

format

public static String format(String fmt,
                            Object... args)