KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > javax > xml > bind > ValidationEvent


1 /*
2  * Copyright 2003 Sun Microsystems, Inc. All rights reserved.
3  * SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms.
4  */
5
6 package javax.xml.bind;
7
8 /**
9  * This event indicates that a problem was encountered while validating the
10  * incoming XML data during an unmarshal operation, while performing
11  * on-demand validation of the Java content tree, or while marshalling the
12  * Java content tree back to XML data.
13  *
14  * @author <ul><li>Ryan Shoemaker, Sun Microsystems, Inc.</li><li>Kohsuke Kawaguchi, Sun Microsystems, Inc.</li><li>Joe Fialli, Sun Microsystems, Inc.</li></ul>
15  * @version $Revision: 1.2 $
16  * @see Validator
17  * @see ValidationEventHandler
18  * @since JAXB1.0
19  */
20 public interface ValidationEvent {
21     
22     /**
23      * Conditions that are not errors or fatal errors as defined by the
24      * XML 1.0 recommendation
25      */
26     public static final int WARNING = 0;
27     
28     /**
29      * Conditions that correspond to the definition of "error" in section
30      * 1.2 of the W3C XML 1.0 Recommendation
31      */
32     public static final int ERROR = 1;
33     
34     /**
35      * Conditions that correspond to the definition of "fatal error" in section
36      * 1.2 of the W3C XML 1.0 Recommendation
37      */
38     public static final int FATAL_ERROR = 2;
39
40     /**
41      * Retrieve the severity code for this warning/error.
42      *
43      * <p>
44      * Must be one of <tt>ValidationError.WARNING</tt>,
45      * <tt>ValidationError.ERROR</tt>, or <tt>ValidationError.FATAL_ERROR</tt>.
46      *
47      * @return the severity code for this warning/error
48      */
49     public int getSeverity();
50     
51     /**
52      * Retrieve the text message for this warning/error.
53      *
54      * @return the text message for this warning/error or null if one wasn't set
55      */
56     public String JavaDoc getMessage();
57     
58     /**
59      * Retrieve the linked exception for this warning/error.
60      *
61      * @return the linked exception for this warning/error or null if one
62      * wasn't set
63      */
64     public Throwable JavaDoc getLinkedException();
65     
66     /**
67      * Retrieve the locator for this warning/error.
68      *
69      * @return the locator that indicates where the warning/error occurred
70      */
71     public ValidationEventLocator getLocator();
72     
73 }
74
Popular Tags