1 /*
   2  * Copyright 2004 Sun Microsystems, Inc.  All Rights Reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.  Sun designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Sun in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
  22  * CA 95054 USA or visit www.sun.com if you need additional information or
  23  * have any questions.
  24  */
  25 
  26 package com.sun.mirror.apt;
  27 
  28 import com.sun.mirror.util.SourcePosition;
  29 
  30 /**
  31  * A <tt>Messager</tt> provides the way for
  32  * an annotation processor to report error messages, warnings, and
  33  * other notices.
  34  *
  35  * @deprecated All components of this API have been superseded by the
  36  * standardized annotation processing API.  The replacement for the
  37  * functionality of this interface is {@link
  38  * javax.annotation.processing.Messager}.
  39  *
  40  * @author Joseph D. Darcy
  41  * @author Scott Seligman
  42  * @since 1.5
  43  */
  44 @Deprecated
  45 @SuppressWarnings("deprecation")
  46 public interface Messager {
  47 
  48     /**
  49      * Prints an error message.
  50      * Equivalent to <tt>printError(null, msg)</tt>.
  51      * @param msg  the message, or an empty string if none
  52      */
  53     void printError(String msg);
  54 
  55     /**
  56      * Prints an error message.
  57      * @param pos  the position where the error occured, or null if it is
  58      *                  unknown or not applicable
  59      * @param msg  the message, or an empty string if none
  60      */
  61     void printError(SourcePosition pos, String msg);
  62 
  63     /**
  64      * Prints a warning message.
  65      * Equivalent to <tt>printWarning(null, msg)</tt>.
  66      * @param msg  the message, or an empty string if none
  67      */
  68     void printWarning(String msg);
  69 
  70     /**
  71      * Prints a warning message.
  72      * @param pos  the position where the warning occured, or null if it is
  73      *                  unknown or not applicable
  74      * @param msg  the message, or an empty string if none
  75      */
  76     void printWarning(SourcePosition pos, String msg);
  77 
  78     /**
  79      * Prints a notice.
  80      * Equivalent to <tt>printNotice(null, msg)</tt>.
  81      * @param msg  the message, or an empty string if none
  82      */
  83     void printNotice(String msg);
  84 
  85     /**
  86      * Prints a notice.
  87      * @param pos  the position where the noticed occured, or null if it is
  88      *                  unknown or not applicable
  89      * @param msg  the message, or an empty string if none
  90      */
  91     void printNotice(SourcePosition pos, String msg);
  92 }