|
1 /* |
|
2 * Copyright (c) 2003, 2013, Oracle and/or its affiliates. All rights reserved. |
|
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
|
4 * |
|
5 * This code is free software; you can redistribute it and/or modify it |
|
6 * under the terms of the GNU General Public License version 2 only, as |
|
7 * published by the Free Software Foundation. Oracle designates this |
|
8 * particular file as subject to the "Classpath" exception as provided |
|
9 * by Oracle 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 Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
|
22 * or visit www.oracle.com if you need additional information or have any |
|
23 * questions. |
|
24 */ |
|
25 |
|
26 package javax.xml.bind; |
|
27 |
|
28 /** |
|
29 * Encapsulate the location of a ValidationEvent. |
|
30 * |
|
31 * <p> |
|
32 * The <tt>ValidationEventLocator</tt> indicates where the <tt>ValidationEvent |
|
33 * </tt> occurred. Different fields will be set depending on the type of |
|
34 * validation that was being performed when the error or warning was detected. |
|
35 * For example, on-demand validation would produce locators that contained |
|
36 * references to objects in the Java content tree while unmarshal-time |
|
37 * validation would produce locators containing information appropriate to the |
|
38 * source of the XML data (file, url, Node, etc). |
|
39 * |
|
40 * @author <ul><li>Ryan Shoemaker, Sun Microsystems, Inc.</li><li>Kohsuke Kawaguchi, Sun Microsystems, Inc.</li><li>Joe Fialli, Sun Microsystems, Inc.</li></ul> |
|
41 * @see Validator |
|
42 * @see ValidationEvent |
|
43 * @since JAXB1.0 |
|
44 */ |
|
45 public interface ValidationEventLocator { |
|
46 |
|
47 /** |
|
48 * Return the name of the XML source as a URL if available |
|
49 * |
|
50 * @return the name of the XML source as a URL or null if unavailable |
|
51 */ |
|
52 public java.net.URL getURL(); |
|
53 |
|
54 /** |
|
55 * Return the byte offset if available |
|
56 * |
|
57 * @return the byte offset into the input source or -1 if unavailable |
|
58 */ |
|
59 public int getOffset(); |
|
60 |
|
61 /** |
|
62 * Return the line number if available |
|
63 * |
|
64 * @return the line number or -1 if unavailable |
|
65 */ |
|
66 public int getLineNumber(); |
|
67 |
|
68 /** |
|
69 * Return the column number if available |
|
70 * |
|
71 * @return the column number or -1 if unavailable |
|
72 */ |
|
73 public int getColumnNumber(); |
|
74 |
|
75 /** |
|
76 * Return a reference to the object in the Java content tree if available |
|
77 * |
|
78 * @return a reference to the object in the Java content tree or null if |
|
79 * unavailable |
|
80 */ |
|
81 public java.lang.Object getObject(); |
|
82 |
|
83 /** |
|
84 * Return a reference to the DOM Node if available |
|
85 * |
|
86 * @return a reference to the DOM Node or null if unavailable |
|
87 */ |
|
88 public org.w3c.dom.Node getNode(); |
|
89 |
|
90 } |