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 {@code ValidationEventLocator} indicates where the {@code ValidationEvent} 33 * 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> 41 * <li>Kohsuke Kawaguchi, Sun Microsystems, Inc.</li> 42 * <li>Joe Fialli, Sun Microsystems, Inc.</li></ul> 43 * @see Validator 44 * @see ValidationEvent 45 * @since 1.6, JAXB 1.0 46 */ 47 public interface ValidationEventLocator { 48 49 /** 50 * Return the name of the XML source as a URL if available 51 * 52 * @return the name of the XML source as a URL or null if unavailable 53 */ 54 public java.net.URL getURL(); 55 56 /** 57 * Return the byte offset if available 58 * 59 * @return the byte offset into the input source or -1 if unavailable 60 */ 61 public int getOffset(); 62 63 /** 64 * Return the line number if available 65 * 66 * @return the line number or -1 if unavailable 67 */ 68 public int getLineNumber(); 69 70 /** 71 * Return the column number if available 72 * 73 * @return the column number or -1 if unavailable 74 */ 75 public int getColumnNumber(); 76 77 /** 78 * Return a reference to the object in the Java content tree if available 79 * 80 * @return a reference to the object in the Java content tree or null if 81 * unavailable 82 */ 83 public java.lang.Object getObject(); 84 85 /** 86 * Return a reference to the DOM Node if available 87 * 88 * @return a reference to the DOM Node or null if unavailable 89 */ 90 public org.w3c.dom.Node getNode(); 91 92 }