01: /*
02: * Copyright 2006 Sun Microsystems, Inc. All Rights Reserved.
03: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
04: *
05: * This code is free software; you can redistribute it and/or modify it
06: * under the terms of the GNU General Public License version 2 only, as
07: * published by the Free Software Foundation. Sun designates this
08: * particular file as subject to the "Classpath" exception as provided
09: * by Sun 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 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
22: * CA 95054 USA or visit www.sun.com if you need additional information or
23: * have any questions.
24: */
25:
26: package com.sun.xml.internal.bind.v2.model.core;
27:
28: import com.sun.xml.internal.bind.v2.model.impl.ModelBuilder;
29: import com.sun.xml.internal.bind.v2.runtime.IllegalAnnotationException;
30:
31: /**
32: * listen to static errors found during building a JAXB model from a set of classes.
33: * Implemented by the client of {@link ModelBuilder}.
34: *
35: * <p>
36: * All the static errors have to be reported while constructing a
37: * model, not when a model is used (IOW, until the {@link ModelBuilder#link} completes.
38: * Internally, {@link ModelBuilder} wraps an {@link ErrorHandler} and all the model
39: * components should report errors through it.
40: *
41: * <p>
42: * {@link IllegalAnnotationException} is a checked exception to remind
43: * the model classes to report it rather than to throw it.
44: *
45: * @see ModelBuilder
46: * @author Kohsuke Kawaguchi
47: */
48: public interface ErrorHandler {
49: /**
50: * Receives a notification for an error in the annotated code.
51: */
52: void error(IllegalAnnotationException e);
53: }
|