Reporter.java revision 3233:b5d08bc0d224 
1/*
2 * Copyright (c) 1998, 2016, 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 jdk.javadoc.doclet;
27
28import javax.lang.model.element.Element;
29import javax.tools.Diagnostic;
30
31import com.sun.source.util.DocTreePath;
32
33/**
34 * This interface provides error, warning and notice reporting.
35 *
36 * @since 9
37 */
38public interface Reporter {
39
40    /**
41     * Print error message and increment error count.
42     *
43     * @param kind specify the diagnostic kind
44     * @param msg message to print
45     */
46    void print(Diagnostic.Kind kind, String msg);
47
48    /**
49     * Print an error message and increment error count.
50     *
51     * @param kind specify the diagnostic kind
52     * @param path the DocTreePath of item where the error occurs
53     * @param msg message to print
54     */
55    void print(Diagnostic.Kind kind, DocTreePath path, String msg);
56
57    /**
58     * Print an error message and increment error count.
59     *
60     * @param kind specify the diagnostic kind
61     * @param e the Element for which  the error occurs
62     * @param msg message to print
63     */
64    void print(Diagnostic.Kind kind, Element e, String msg);
65}
66