01: /*
02: * @(#)Messager.java 1.2 04/07/27
03: *
04: * Copyright (c) 2004, Sun Microsystems, Inc.
05: * All rights reserved.
06: *
07: * Redistribution and use in source and binary forms, with or without
08: * modification, are permitted provided that the following conditions are met:
09: *
10: * * Redistributions of source code must retain the above copyright
11: * notice, this list of conditions and the following disclaimer.
12: * * Redistributions in binary form must reproduce the above copyright
13: * notice, this list of conditions and the following disclaimer in the
14: * documentation and/or other materials provided with the distribution.
15: * * Neither the name of the Sun Microsystems, Inc. nor the names of
16: * its contributors may be used to endorse or promote products derived from
17: * this software without specific prior written permission.
18: *
19: * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
20: * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
21: * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
22: * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
23: * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
24: * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
25: * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
26: * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
27: * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
28: * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
29: * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30: */
31:
32: package com.sun.mirror.apt;
33:
34: import com.sun.mirror.util.SourcePosition;
35:
36: /**
37: * A <tt>Messager</tt> provides the way for
38: * an annotation processor to report error messages, warnings, and
39: * other notices.
40: *
41: * @author Joseph D. Darcy
42: * @author Scott Seligman
43: * @version 1.2 04/07/27
44: * @since 1.5
45: */
46:
47: public interface Messager {
48:
49: /**
50: * Prints an error message.
51: * Equivalent to <tt>printError(null, msg)</tt>.
52: * @param msg the message, or an empty string if none
53: */
54: void printError(String msg);
55:
56: /**
57: * Prints an error message.
58: * @param pos the position where the error occured, or null if it is
59: * unknown or not applicable
60: * @param msg the message, or an empty string if none
61: */
62: void printError(SourcePosition pos, String msg);
63:
64: /**
65: * Prints a warning message.
66: * Equivalent to <tt>printWarning(null, msg)</tt>.
67: * @param msg the message, or an empty string if none
68: */
69: void printWarning(String msg);
70:
71: /**
72: * Prints a warning message.
73: * @param pos the position where the warning occured, or null if it is
74: * unknown or not applicable
75: * @param msg the message, or an empty string if none
76: */
77: void printWarning(SourcePosition pos, String msg);
78:
79: /**
80: * Prints a notice.
81: * Equivalent to <tt>printNotice(null, msg)</tt>.
82: * @param msg the message, or an empty string if none
83: */
84: void printNotice(String msg);
85:
86: /**
87: * Prints a notice.
88: * @param pos the position where the noticed occured, or null if it is
89: * unknown or not applicable
90: * @param msg the message, or an empty string if none
91: */
92: void printNotice(SourcePosition pos, String msg);
93: }
|