src/share/jaxws_classes/javax/xml/bind/ValidationEventHandler.java

Tue, 06 Mar 2012 16:09:35 -0800

author
ohair
date
Tue, 06 Mar 2012 16:09:35 -0800
changeset 286
f50545b5e2f1
child 397
b99d7e355d4b
permissions
-rw-r--r--

7150322: Stop using drop source bundles in jaxws
Reviewed-by: darcy, ohrstrom

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

mercurial