Mercurial > jdk8-mips64-public > jaxws / annotate
src/share/jaxws_classes/javax/xml/bind/ValidationEventHandler.java@9c07ef4934dd (annotated)
src/share/jaxws_classes/javax/xml/bind/ValidationEventHandler.java
Thu, 31 Aug 2017 15:18:52 +0800
- author
- aoqi
- date
- Thu, 31 Aug 2017 15:18:52 +0800
- changeset 637
- 9c07ef4934dd
- parent 397
- b99d7e355d4b
- parent 0
- 373ffda63c9a
- permissions
- -rw-r--r--
merge
| aoqi@0 | 1 | /* |
| aoqi@0 | 2 | * Copyright (c) 2003, 2013, Oracle and/or its affiliates. All rights reserved. |
| aoqi@0 | 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
| aoqi@0 | 4 | * |
| aoqi@0 | 5 | * This code is free software; you can redistribute it and/or modify it |
| aoqi@0 | 6 | * under the terms of the GNU General Public License version 2 only, as |
| aoqi@0 | 7 | * published by the Free Software Foundation. Oracle designates this |
| aoqi@0 | 8 | * particular file as subject to the "Classpath" exception as provided |
| aoqi@0 | 9 | * by Oracle in the LICENSE file that accompanied this code. |
| aoqi@0 | 10 | * |
| aoqi@0 | 11 | * This code is distributed in the hope that it will be useful, but WITHOUT |
| aoqi@0 | 12 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
| aoqi@0 | 13 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
| aoqi@0 | 14 | * version 2 for more details (a copy is included in the LICENSE file that |
| aoqi@0 | 15 | * accompanied this code). |
| aoqi@0 | 16 | * |
| aoqi@0 | 17 | * You should have received a copy of the GNU General Public License version |
| aoqi@0 | 18 | * 2 along with this work; if not, write to the Free Software Foundation, |
| aoqi@0 | 19 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
| aoqi@0 | 20 | * |
| aoqi@0 | 21 | * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
| aoqi@0 | 22 | * or visit www.oracle.com if you need additional information or have any |
| aoqi@0 | 23 | * questions. |
| aoqi@0 | 24 | */ |
| aoqi@0 | 25 | |
| aoqi@0 | 26 | package javax.xml.bind; |
| aoqi@0 | 27 | |
| aoqi@0 | 28 | /** |
| aoqi@0 | 29 | * A basic event handler interface for validation errors. |
| aoqi@0 | 30 | * |
| aoqi@0 | 31 | * <p> |
| aoqi@0 | 32 | * If an application needs to implement customized event handling, it must |
| aoqi@0 | 33 | * implement this interface and then register it with either the |
| aoqi@0 | 34 | * {@link Unmarshaller#setEventHandler(ValidationEventHandler) Unmarshaller}, |
| aoqi@0 | 35 | * the {@link Validator#setEventHandler(ValidationEventHandler) Validator}, or |
| aoqi@0 | 36 | * the {@link Marshaller#setEventHandler(ValidationEventHandler) Marshaller}. |
| aoqi@0 | 37 | * The JAXB Provider will then report validation errors and warnings encountered |
| aoqi@0 | 38 | * during the unmarshal, marshal, and validate operations to these event |
| aoqi@0 | 39 | * handlers. |
| aoqi@0 | 40 | * |
| aoqi@0 | 41 | * <p> |
| aoqi@0 | 42 | * If the <tt>handleEvent</tt> method throws an unchecked runtime exception, |
| aoqi@0 | 43 | * the JAXB Provider must treat that as if the method returned false, effectively |
| aoqi@0 | 44 | * terminating whatever operation was in progress at the time (unmarshal, |
| aoqi@0 | 45 | * validate, or marshal). |
| aoqi@0 | 46 | * |
| aoqi@0 | 47 | * <p> |
| aoqi@0 | 48 | * Modifying the Java content tree within your event handler is undefined |
| aoqi@0 | 49 | * by the specification and may result in unexpected behaviour. |
| aoqi@0 | 50 | * |
| aoqi@0 | 51 | * <p> |
| aoqi@0 | 52 | * Failing to return false from the <tt>handleEvent</tt> method after |
| aoqi@0 | 53 | * encountering a fatal error is undefined by the specification and may result |
| aoqi@0 | 54 | * in unexpected behavior. |
| aoqi@0 | 55 | * |
| aoqi@0 | 56 | * <p> |
| aoqi@0 | 57 | * <b>Default Event Handler</b> |
| aoqi@0 | 58 | * <blockquote> |
| aoqi@0 | 59 | * See: <a href="Validator.html#defaulthandler">Validator javadocs</a> |
| aoqi@0 | 60 | * </blockquote> |
| aoqi@0 | 61 | * |
| aoqi@0 | 62 | * @author <ul><li>Ryan Shoemaker, Sun Microsystems, Inc.</li><li>Kohsuke Kawaguchi, Sun Microsystems, Inc.</li><li>Joe Fialli, Sun Microsystems, Inc.</li></ul> |
| aoqi@0 | 63 | * @see Unmarshaller |
| aoqi@0 | 64 | * @see Validator |
| aoqi@0 | 65 | * @see Marshaller |
| aoqi@0 | 66 | * @see ValidationEvent |
| aoqi@0 | 67 | * @see javax.xml.bind.util.ValidationEventCollector |
| aoqi@0 | 68 | * @since JAXB1.0 |
| aoqi@0 | 69 | */ |
| aoqi@0 | 70 | public interface ValidationEventHandler { |
| aoqi@0 | 71 | /** |
| aoqi@0 | 72 | * Receive notification of a validation warning or error. |
| aoqi@0 | 73 | * |
| aoqi@0 | 74 | * The ValidationEvent will have a |
| aoqi@0 | 75 | * {@link ValidationEventLocator ValidationEventLocator} embedded in it that |
| aoqi@0 | 76 | * indicates where the error or warning occurred. |
| aoqi@0 | 77 | * |
| aoqi@0 | 78 | * <p> |
| aoqi@0 | 79 | * If an unchecked runtime exception is thrown from this method, the JAXB |
| aoqi@0 | 80 | * provider will treat it as if the method returned false and interrupt |
| aoqi@0 | 81 | * the current unmarshal, validate, or marshal operation. |
| aoqi@0 | 82 | * |
| aoqi@0 | 83 | * @param event the encapsulated validation event information. It is a |
| aoqi@0 | 84 | * provider error if this parameter is null. |
| aoqi@0 | 85 | * @return true if the JAXB Provider should attempt to continue the current |
| aoqi@0 | 86 | * unmarshal, validate, or marshal operation after handling this |
| aoqi@0 | 87 | * warning/error, false if the provider should terminate the current |
| aoqi@0 | 88 | * operation with the appropriate <tt>UnmarshalException</tt>, |
| aoqi@0 | 89 | * <tt>ValidationException</tt>, or <tt>MarshalException</tt>. |
| aoqi@0 | 90 | * @throws IllegalArgumentException if the event object is null. |
| aoqi@0 | 91 | */ |
| aoqi@0 | 92 | public boolean handleEvent( ValidationEvent event ); |
| aoqi@0 | 93 | |
| aoqi@0 | 94 | } |
