DiagnosticListener.java revision 2571:10fc81ac75b4 
1/*
2 * Copyright (c) 2005, 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 javax.tools;
27
28/**
29 * Interface for receiving diagnostics from tools.
30 *
31 * @param <S> the type of source objects used by diagnostics received
32 * by this listener
33 *
34 * @author Jonathan Gibbons
35 * @author Peter von der Ah&eacute;
36 * @since 1.6
37 */
38public interface DiagnosticListener<S> {
39    /**
40     * Invoked when a problem is found.
41     *
42     * @param diagnostic a diagnostic representing the problem that
43     * was found
44     * @throws NullPointerException if the diagnostic argument is
45     * {@code null} and the implementation cannot handle {@code null}
46     * arguments
47     */
48    void report(Diagnostic<? extends S> diagnostic);
49}
50