Thu, 31 Aug 2017 15:18:52 +0800
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 | * Encapsulate the location of a ValidationEvent. |
aoqi@0 | 30 | * |
aoqi@0 | 31 | * <p> |
aoqi@0 | 32 | * The <tt>ValidationEventLocator</tt> indicates where the <tt>ValidationEvent |
aoqi@0 | 33 | * </tt> occurred. Different fields will be set depending on the type of |
aoqi@0 | 34 | * validation that was being performed when the error or warning was detected. |
aoqi@0 | 35 | * For example, on-demand validation would produce locators that contained |
aoqi@0 | 36 | * references to objects in the Java content tree while unmarshal-time |
aoqi@0 | 37 | * validation would produce locators containing information appropriate to the |
aoqi@0 | 38 | * source of the XML data (file, url, Node, etc). |
aoqi@0 | 39 | * |
aoqi@0 | 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> |
aoqi@0 | 41 | * @see Validator |
aoqi@0 | 42 | * @see ValidationEvent |
aoqi@0 | 43 | * @since JAXB1.0 |
aoqi@0 | 44 | */ |
aoqi@0 | 45 | public interface ValidationEventLocator { |
aoqi@0 | 46 | |
aoqi@0 | 47 | /** |
aoqi@0 | 48 | * Return the name of the XML source as a URL if available |
aoqi@0 | 49 | * |
aoqi@0 | 50 | * @return the name of the XML source as a URL or null if unavailable |
aoqi@0 | 51 | */ |
aoqi@0 | 52 | public java.net.URL getURL(); |
aoqi@0 | 53 | |
aoqi@0 | 54 | /** |
aoqi@0 | 55 | * Return the byte offset if available |
aoqi@0 | 56 | * |
aoqi@0 | 57 | * @return the byte offset into the input source or -1 if unavailable |
aoqi@0 | 58 | */ |
aoqi@0 | 59 | public int getOffset(); |
aoqi@0 | 60 | |
aoqi@0 | 61 | /** |
aoqi@0 | 62 | * Return the line number if available |
aoqi@0 | 63 | * |
aoqi@0 | 64 | * @return the line number or -1 if unavailable |
aoqi@0 | 65 | */ |
aoqi@0 | 66 | public int getLineNumber(); |
aoqi@0 | 67 | |
aoqi@0 | 68 | /** |
aoqi@0 | 69 | * Return the column number if available |
aoqi@0 | 70 | * |
aoqi@0 | 71 | * @return the column number or -1 if unavailable |
aoqi@0 | 72 | */ |
aoqi@0 | 73 | public int getColumnNumber(); |
aoqi@0 | 74 | |
aoqi@0 | 75 | /** |
aoqi@0 | 76 | * Return a reference to the object in the Java content tree if available |
aoqi@0 | 77 | * |
aoqi@0 | 78 | * @return a reference to the object in the Java content tree or null if |
aoqi@0 | 79 | * unavailable |
aoqi@0 | 80 | */ |
aoqi@0 | 81 | public java.lang.Object getObject(); |
aoqi@0 | 82 | |
aoqi@0 | 83 | /** |
aoqi@0 | 84 | * Return a reference to the DOM Node if available |
aoqi@0 | 85 | * |
aoqi@0 | 86 | * @return a reference to the DOM Node or null if unavailable |
aoqi@0 | 87 | */ |
aoqi@0 | 88 | public org.w3c.dom.Node getNode(); |
aoqi@0 | 89 | |
aoqi@0 | 90 | } |