Package com.sun.tools.javac.util

Class MandatoryWarningHandler

java.lang.Object

com.sun.tools.javac.util.MandatoryWarningHandler

public class MandatoryWarningHandler
extends Object

A handler to process mandatory warnings, setting up a deferred diagnostic to be printed at the end of the compilation if some warnings get suppressed because too many warnings have already been generated. Note that the SuppressWarnings annotation can be used to suppress warnings about conditions that would otherwise merit a warning. Such processing is done when the condition is detected, and in those cases, no call is made on any API to generate a warning at all. In consequence, this handler only gets to handle those warnings that JLS says must be generated.

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.

Constructor Summary

Constructors

Constructor and Description
MandatoryWarningHandler(Log log, boolean verbose, boolean enforceMandatory, String prefix, Lint.LintCategory lc) Create a handler for mandatory warnings.

Method Summary

Modifier and Type	Method and Description
void	report(JCDiagnostic.DiagnosticPosition pos, String msg, Object... args) Report a mandatory warning.
void	reportDeferredDiagnostic() Report any diagnostic that might have been deferred by previous calls of report().

Methods inherited from class java.lang.Object

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

Constructor Detail

MandatoryWarningHandler

public MandatoryWarningHandler(Log log,
                               boolean verbose,
                               boolean enforceMandatory,
                               String prefix,
                               Lint.LintCategory lc)

Create a handler for mandatory warnings.

Parameters:

log - The log on which to generate any diagnostics

verbose - Specify whether or not detailed messages about individual instances should be given, or whether an aggregate message should be generated at the end of the compilation. Typically set via -Xlint:option.

enforceMandatory - True if mandatory warnings and notes are being enforced.

prefix - A common prefix for the set of message keys for the messages that may be generated.

lc - An associated lint category for the warnings, or null if none.

Method Detail

report

public void report(JCDiagnostic.DiagnosticPosition pos,
                   String msg,
                   Object... args)

Report a mandatory warning.

reportDeferredDiagnostic

public void reportDeferredDiagnostic()

Report any diagnostic that might have been deferred by previous calls of report().