Class Messager

  • All Implemented Interfaces:
    DocErrorReporter

    @Deprecated
    public class Messager
    extends com.sun.tools.javac.util.Log
    implements DocErrorReporter
    Deprecated.
    Utility for integrating with javadoc tools and for localization. Handle Resources. Access to error and warning counts. Message formatting.
    Also provides implementation for DocErrorReporter.

    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.

    Author:
    Neal Gafter (rewrite)
    See Also:
    ResourceBundle, MessageFormat
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      class  Messager.ExitJavadoc
      Deprecated.
       
      • Nested classes/interfaces inherited from class com.sun.tools.javac.util.Log

        com.sun.tools.javac.util.Log.DeferredDiagnosticHandler, com.sun.tools.javac.util.Log.DiagnosticHandler, com.sun.tools.javac.util.Log.DiscardDiagnosticHandler, com.sun.tools.javac.util.Log.PrefixKind, com.sun.tools.javac.util.Log.WriterKind
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static SourcePosition NOPOS
      Deprecated.
       
      • Fields inherited from class com.sun.tools.javac.util.Log

        compressedOutput, diagListener, dumpOnError, emitWarnings, errKey, expectDiagKeys, logKey, MaxErrors, MaxWarnings, nerrors, nwarnings, outKey, promptOnError, recorded, recordedSourceLevelErrors, suppressNotes
      • Fields inherited from class com.sun.tools.javac.util.AbstractLog

        diags, source, sourceMap
    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      protected Messager​(com.sun.tools.javac.util.Context context, String programName)
      Deprecated.
      Constructor
      protected Messager​(com.sun.tools.javac.util.Context context, String programName, PrintWriter errWriter, PrintWriter warnWriter, PrintWriter noticeWriter)
      Deprecated.
      Constructor
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      void error​(SourcePosition pos, String key, Object... args)
      Deprecated.
      Print error message, increment error count.
      void exit()
      Deprecated.
      Force program exit, e.g., from a fatal error.
      void exitNotice()
      Deprecated.
      Print exit message.
      static Messager instance0​(com.sun.tools.javac.util.Context context)
      Deprecated.
      Get the current messager, which is also the compiler log.
      int nerrors()
      Deprecated.
      Return total number of errors, including those recorded in the compilation log.
      void notice​(String key, Object... args)
      Deprecated.
      Print a message.
      int nwarnings()
      Deprecated.
      Return total number of warnings, including those recorded in the compilation log.
      static void preRegister​(com.sun.tools.javac.util.Context context, String programName)
      Deprecated.
       
      static void preRegister​(com.sun.tools.javac.util.Context context, String programName, PrintWriter errWriter, PrintWriter warnWriter, PrintWriter noticeWriter)
      Deprecated.
       
      void printError​(SourcePosition pos, String msg)
      Deprecated.
      Print error message, increment error count.
      void printError​(String msg)
      Deprecated.
      Print error message, increment error count.
      void printNotice​(SourcePosition pos, String msg)
      Deprecated.
      Print a message.
      void printNotice​(String msg)
      Deprecated.
      Print a message.
      void printWarning​(SourcePosition pos, String msg)
      Deprecated.
      Print warning message, increment warning count.
      void printWarning​(String msg)
      Deprecated.
      Print warning message, increment warning count.
      void setLocale​(Locale locale)
      Deprecated.
       
      void warning​(SourcePosition pos, String key, Object... args)
      Deprecated.
      Print warning message, increment warning count.
      • Methods inherited from class com.sun.tools.javac.util.Log

        currentSourceFile, directError, flush, flush, format, getDefaultMaxErrors, getDefaultMaxWarnings, getDiagnosticFormatter, getLocalizedString, getWriter, getWriterForDiagnosticType, hasDiagnosticListener, instance, localize, localize, localize, popDiagnosticHandler, preRegister, printLines, printLines, printLines, printLines, printLines, printNewline, printNewline, printRawLines, printRawLines, printRawLines, printVerbose, prompt, rawError, rawWarning, report, setDiagnosticFormatter, setEndPosTable, setWriter, setWriters, shouldReport, strictWarning, writeDiagnostic
      • Methods inherited from class com.sun.tools.javac.util.AbstractLog

        currentSource, error, error, error, error, error, error, error, getSource, mandatoryNote, mandatoryWarning, mandatoryWarning, note, note, note, note, useSource, warning, warning, warning, warning, warning
    • Constructor Detail

      • Messager

        protected Messager​(com.sun.tools.javac.util.Context context,
                           String programName)
        Deprecated.
        Constructor
        Parameters:
        programName - Name of the program (for error messages).
      • Messager

        protected Messager​(com.sun.tools.javac.util.Context context,
                           String programName,
                           PrintWriter errWriter,
                           PrintWriter warnWriter,
                           PrintWriter noticeWriter)
        Deprecated.
        Constructor
        Parameters:
        programName - Name of the program (for error messages).
        errWriter - Stream for error messages
        warnWriter - Stream for warnings
        noticeWriter - Stream for other messages
    • Method Detail

      • instance0

        public static Messager instance0​(com.sun.tools.javac.util.Context context)
        Deprecated.
        Get the current messager, which is also the compiler log.
      • preRegister

        public static void preRegister​(com.sun.tools.javac.util.Context context,
                                       String programName)
        Deprecated.
      • preRegister

        public static void preRegister​(com.sun.tools.javac.util.Context context,
                                       String programName,
                                       PrintWriter errWriter,
                                       PrintWriter warnWriter,
                                       PrintWriter noticeWriter)
        Deprecated.
      • setLocale

        public void setLocale​(Locale locale)
        Deprecated.
      • printError

        public void printError​(String msg)
        Deprecated.
        Print error message, increment error count. Part of DocErrorReporter.
        Specified by:
        printError in interface DocErrorReporter
        Parameters:
        msg - message to print
      • printError

        public void printError​(SourcePosition pos,
                               String msg)
        Deprecated.
        Print error message, increment error count. Part of DocErrorReporter.
        Specified by:
        printError in interface DocErrorReporter
        Parameters:
        pos - the position where the error occurs
        msg - message to print
      • printWarning

        public void printWarning​(String msg)
        Deprecated.
        Print warning message, increment warning count. Part of DocErrorReporter.
        Specified by:
        printWarning in interface DocErrorReporter
        Parameters:
        msg - message to print
      • printWarning

        public void printWarning​(SourcePosition pos,
                                 String msg)
        Deprecated.
        Print warning message, increment warning count. Part of DocErrorReporter.
        Specified by:
        printWarning in interface DocErrorReporter
        Parameters:
        pos - the position where the error occurs
        msg - message to print
      • printNotice

        public void printNotice​(String msg)
        Deprecated.
        Print a message. Part of DocErrorReporter.
        Specified by:
        printNotice in interface DocErrorReporter
        Parameters:
        msg - message to print
      • printNotice

        public void printNotice​(SourcePosition pos,
                                String msg)
        Deprecated.
        Print a message. Part of DocErrorReporter.
        Specified by:
        printNotice in interface DocErrorReporter
        Parameters:
        pos - the position where the error occurs
        msg - message to print
      • error

        public void error​(SourcePosition pos,
                          String key,
                          Object... args)
        Deprecated.
        Print error message, increment error count.
        Parameters:
        key - selects message from resource
      • warning

        public void warning​(SourcePosition pos,
                            String key,
                            Object... args)
        Deprecated.
        Print warning message, increment warning count.
        Parameters:
        key - selects message from resource
      • notice

        public void notice​(String key,
                           Object... args)
        Deprecated.
        Print a message.
        Parameters:
        key - selects message from resource
      • nerrors

        public int nerrors()
        Deprecated.
        Return total number of errors, including those recorded in the compilation log.
      • nwarnings

        public int nwarnings()
        Deprecated.
        Return total number of warnings, including those recorded in the compilation log.
      • exitNotice

        public void exitNotice()
        Deprecated.
        Print exit message.
      • exit

        public void exit()
        Deprecated.
        Force program exit, e.g., from a fatal error.

        TODO: This method does not really belong here.