ohair@286: /*
mkos@397:  * Copyright (c) 2003, 2013, 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:  * Encapsulate the location of a ValidationEvent.
ohair@286:  *
ohair@286:  * <p>
ohair@286:  * The <tt>ValidationEventLocator</tt> indicates where the <tt>ValidationEvent
ohair@286:  * </tt> occurred.  Different fields will be set depending on the type of
ohair@286:  * validation that was being performed when the error or warning was detected.
ohair@286:  * For example, on-demand validation would produce locators that contained
ohair@286:  * references to objects in the Java content tree while unmarshal-time
ohair@286:  * validation would produce locators containing information appropriate to the
ohair@286:  * source of the XML data (file, url, Node, etc).
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 ValidationEvent
ohair@286:  * @since JAXB1.0
ohair@286:  */
ohair@286: public interface ValidationEventLocator {
ohair@286: 
ohair@286:     /**
ohair@286:      * Return the name of the XML source as a URL if available
ohair@286:      *
ohair@286:      * @return the name of the XML source as a URL or null if unavailable
ohair@286:      */
ohair@286:     public java.net.URL getURL();
ohair@286: 
ohair@286:     /**
ohair@286:      * Return the byte offset if available
ohair@286:      *
ohair@286:      * @return the byte offset into the input source or -1 if unavailable
ohair@286:      */
ohair@286:     public int getOffset();
ohair@286: 
ohair@286:     /**
ohair@286:      * Return the line number if available
ohair@286:      *
ohair@286:      * @return the line number or -1 if unavailable
ohair@286:      */
ohair@286:     public int getLineNumber();
ohair@286: 
ohair@286:     /**
ohair@286:      * Return the column number if available
ohair@286:      *
ohair@286:      * @return the column number or -1 if unavailable
ohair@286:      */
ohair@286:     public int getColumnNumber();
ohair@286: 
ohair@286:     /**
ohair@286:      * Return a reference to the object in the Java content tree if available
ohair@286:      *
ohair@286:      * @return a reference to the object in the Java content tree or null if
ohair@286:      *         unavailable
ohair@286:      */
ohair@286:     public java.lang.Object getObject();
ohair@286: 
ohair@286:     /**
ohair@286:      * Return a reference to the DOM Node if available
ohair@286:      *
ohair@286:      * @return a reference to the DOM Node or null if unavailable
ohair@286:      */
ohair@286:     public org.w3c.dom.Node getNode();
ohair@286: 
ohair@286: }