01: /*
02: * Copyright 2004 Sun Microsystems, Inc. All Rights Reserved.
03: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
04: *
05: * This code is free software; you can redistribute it and/or modify it
06: * under the terms of the GNU General Public License version 2 only, as
07: * published by the Free Software Foundation. Sun designates this
08: * particular file as subject to the "Classpath" exception as provided
09: * 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: * @author Joseph D. Darcy
36: * @author Scott Seligman
37: * @version 1.9 07/05/05
38: * @since 1.5
39: */
40:
41: public interface Messager {
42:
43: /**
44: * Prints an error message.
45: * Equivalent to <tt>printError(null, msg)</tt>.
46: * @param msg the message, or an empty string if none
47: */
48: void printError(String msg);
49:
50: /**
51: * Prints an error message.
52: * @param pos the position where the error occured, or null if it is
53: * unknown or not applicable
54: * @param msg the message, or an empty string if none
55: */
56: void printError(SourcePosition pos, String msg);
57:
58: /**
59: * Prints a warning message.
60: * Equivalent to <tt>printWarning(null, msg)</tt>.
61: * @param msg the message, or an empty string if none
62: */
63: void printWarning(String msg);
64:
65: /**
66: * Prints a warning message.
67: * @param pos the position where the warning occured, or null if it is
68: * unknown or not applicable
69: * @param msg the message, or an empty string if none
70: */
71: void printWarning(SourcePosition pos, String msg);
72:
73: /**
74: * Prints a notice.
75: * Equivalent to <tt>printNotice(null, msg)</tt>.
76: * @param msg the message, or an empty string if none
77: */
78: void printNotice(String msg);
79:
80: /**
81: * Prints a notice.
82: * @param pos the position where the noticed occured, or null if it is
83: * unknown or not applicable
84: * @param msg the message, or an empty string if none
85: */
86: void printNotice(SourcePosition pos, String msg);
87: }
|