ohair@286: /*
ohair@286:  * Copyright (c) 2003, 2010, Oracle and/or its affiliates. All rights reserved.
ohair@286:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
ohair@286:  *
ohair@286:  * This code is free software; you can redistribute it and/or modify it
ohair@286:  * under the terms of the GNU General Public License version 2 only, as
ohair@286:  * published by the Free Software Foundation.  Oracle designates this
ohair@286:  * particular file as subject to the "Classpath" exception as provided
ohair@286:  * by Oracle in the LICENSE file that accompanied this code.
ohair@286:  *
ohair@286:  * This code is distributed in the hope that it will be useful, but WITHOUT
ohair@286:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
ohair@286:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
ohair@286:  * version 2 for more details (a copy is included in the LICENSE file that
ohair@286:  * accompanied this code).
ohair@286:  *
ohair@286:  * You should have received a copy of the GNU General Public License version
ohair@286:  * 2 along with this work; if not, write to the Free Software Foundation,
ohair@286:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
ohair@286:  *
ohair@286:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
ohair@286:  * or visit www.oracle.com if you need additional information or have any
ohair@286:  * questions.
ohair@286:  */
ohair@286: 
ohair@286: package javax.xml.bind;
ohair@286: 
ohair@286: /**
ohair@286:  * This event indicates that a problem was encountered while validating the
ohair@286:  * incoming XML data during an unmarshal operation, while performing
ohair@286:  * on-demand validation of the Java content tree, or while marshalling the
ohair@286:  * Java content tree back to XML data.
ohair@286:  *
ohair@286:  * @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:  * @see Validator
ohair@286:  * @see ValidationEventHandler
ohair@286:  * @since JAXB1.0
ohair@286:  */
ohair@286: public interface ValidationEvent {
ohair@286: 
ohair@286:     /**
ohair@286:      * Conditions that are not errors or fatal errors as defined by the
ohair@286:      * XML 1.0 recommendation
ohair@286:      */
ohair@286:     public static final int WARNING     = 0;
ohair@286: 
ohair@286:     /**
ohair@286:      * Conditions that correspond to the definition of "error" in section
ohair@286:      * 1.2 of the W3C XML 1.0 Recommendation
ohair@286:      */
ohair@286:     public static final int ERROR       = 1;
ohair@286: 
ohair@286:     /**
ohair@286:      * Conditions that correspond to the definition of "fatal error" in section
ohair@286:      * 1.2 of the W3C XML 1.0 Recommendation
ohair@286:      */
ohair@286:     public static final int FATAL_ERROR = 2;
ohair@286: 
ohair@286:     /**
ohair@286:      * Retrieve the severity code for this warning/error.
ohair@286:      *
ohair@286:      * <p>
ohair@286:      * Must be one of <tt>ValidationError.WARNING</tt>,
ohair@286:      * <tt>ValidationError.ERROR</tt>, or <tt>ValidationError.FATAL_ERROR</tt>.
ohair@286:      *
ohair@286:      * @return the severity code for this warning/error
ohair@286:      */
ohair@286:     public int getSeverity();
ohair@286: 
ohair@286:     /**
ohair@286:      * Retrieve the text message for this warning/error.
ohair@286:      *
ohair@286:      * @return the text message for this warning/error or null if one wasn't set
ohair@286:      */
ohair@286:     public String getMessage();
ohair@286: 
ohair@286:     /**
ohair@286:      * Retrieve the linked exception for this warning/error.
ohair@286:      *
ohair@286:      * @return the linked exception for this warning/error or null if one
ohair@286:      *         wasn't set
ohair@286:      */
ohair@286:     public Throwable getLinkedException();
ohair@286: 
ohair@286:     /**
ohair@286:      * Retrieve the locator for this warning/error.
ohair@286:      *
ohair@286:      * @return the locator that indicates where the warning/error occurred
ohair@286:      */
ohair@286:     public ValidationEventLocator getLocator();
ohair@286: 
ohair@286: }