KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > sun > javadoc > DocErrorReporter


1 /*
2  * @(#)DocErrorReporter.java 1.8 02/10/06
3  *
4  * Copyright 2004 Sun Microsystems, Inc. All rights reserved.
5  * SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms.
6  */

7
8 package com.sun.javadoc;
9
10 /**
11  * This interface provides error, warning and notice printing.
12  *
13  * @since JDK1.2
14  * @author Robert Field
15  */

16 public interface DocErrorReporter {
17
18     /**
19      * Print error message and increment error count.
20      *
21      * @param msg message to print
22      */

23     void printError(String JavaDoc msg);
24
25     /**
26      * Print an error message and increment error count.
27      *
28      * @param pos the position item where the error occurs
29      * @param msg message to print
30      * @since 1.4
31      */

32     void printError(SourcePosition pos, String JavaDoc msg);
33
34     /**
35      * Print warning message and increment warning count.
36      *
37      * @param msg message to print
38      */

39     void printWarning(String JavaDoc msg);
40
41     /**
42      * Print warning message and increment warning count.
43      *
44      * @param pos the position item where the warning occurs
45      * @param msg message to print
46      * @since 1.4
47      */

48     void printWarning(SourcePosition pos, String JavaDoc msg);
49
50     /**
51      * Print a message.
52      *
53      * @param msg message to print
54      */

55     void printNotice(String JavaDoc msg);
56
57     /**
58      * Print a message.
59      *
60      * @param pos the position item where the message occurs
61      * @param msg message to print
62      * @since 1.4
63      */

64     void printNotice(SourcePosition pos, String JavaDoc msg);
65 }
66
Popular Tags