DocErrorReporter.java revision 2571:10fc81ac75b4 
1/*
2 * Copyright (c) 1998, 2006, Oracle and/or its affiliates. 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.  Oracle designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Oracle 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 Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22 * or visit www.oracle.com if you need additional information or have any
23 * questions.
24 */
25
26package com.sun.javadoc;
27
28/**
29 * This interface provides error, warning and notice printing.
30 *
31 * @since 1.2
32 * @author Robert Field
33 */
34public interface DocErrorReporter {
35
36    /**
37     * Print error message and increment error count.
38     *
39     * @param msg message to print
40     */
41    void printError(String msg);
42
43    /**
44     * Print an error message and increment error count.
45     *
46     * @param pos the position item where the error occurs
47     * @param msg message to print
48     * @since 1.4
49     */
50    void printError(SourcePosition pos, String msg);
51
52    /**
53     * Print warning message and increment warning count.
54     *
55     * @param msg message to print
56     */
57    void printWarning(String msg);
58
59    /**
60     * Print warning message and increment warning count.
61     *
62     * @param pos the position item where the warning occurs
63     * @param msg message to print
64     * @since 1.4
65     */
66    void printWarning(SourcePosition pos, String msg);
67
68    /**
69     * Print a message.
70     *
71     * @param msg message to print
72     */
73    void printNotice(String msg);
74
75    /**
76     * Print a message.
77     *
78     * @param pos the position item where the message occurs
79     * @param msg message to print
80     * @since 1.4
81     */
82    void printNotice(SourcePosition pos, String msg);
83}
84