1/*
2 * Copyright (c) 1997, 2017, 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.xml.internal.bind.v2.model.core;
27
28import com.sun.xml.internal.bind.v2.runtime.IllegalAnnotationException;
29
30/**
31 * listen to static errors found during building a JAXB model from a set of classes.
32 * Implemented by the client of {@link com.sun.xml.internal.bind.v2.model.impl.ModelBuilderI}.
33 *
34 * <p>
35 * All the static errors have to be reported while constructing a
36 * model, not when a model is used (IOW, until the {@link com.sun.xml.internal.bind.v2.model.impl.ModelBuilderI} completes.
37 * Internally, {@link com.sun.xml.internal.bind.v2.model.impl.ModelBuilderI} wraps an {@link ErrorHandler} and all the model
38 * components should report errors through it.
39 *
40 * <p>
41 * {@link IllegalAnnotationException} is a checked exception to remind
42 * the model classes to report it rather than to throw it.
43 *
44 * @see com.sun.xml.internal.bind.v2.model.impl.ModelBuilderI
45 * @author Kohsuke Kawaguchi
46 */
47public interface ErrorHandler {
48    /**
49     * Receives a notification for an error in the annotated code.
50     * @param e
51     */
52    void error( IllegalAnnotationException e );
53}
54