src/share/jaxws_classes/javax/xml/bind/ValidationEventLocator.java

Fri, 04 Oct 2013 16:21:34 +0100

author
mkos
date
Fri, 04 Oct 2013 16:21:34 +0100
changeset 408
b0610cd08440
parent 397
b99d7e355d4b
child 637
9c07ef4934dd
permissions
-rw-r--r--

8025054: Update JAX-WS RI integration to 2.2.9-b130926.1035
Reviewed-by: chegar

ohair@286 1 /*
mkos@397 2 * Copyright (c) 2003, 2013, Oracle and/or its affiliates. All rights reserved.
ohair@286 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
ohair@286 4 *
ohair@286 5 * This code is free software; you can redistribute it and/or modify it
ohair@286 6 * under the terms of the GNU General Public License version 2 only, as
ohair@286 7 * published by the Free Software Foundation. Oracle designates this
ohair@286 8 * particular file as subject to the "Classpath" exception as provided
ohair@286 9 * by Oracle in the LICENSE file that accompanied this code.
ohair@286 10 *
ohair@286 11 * This code is distributed in the hope that it will be useful, but WITHOUT
ohair@286 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
ohair@286 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
ohair@286 14 * version 2 for more details (a copy is included in the LICENSE file that
ohair@286 15 * accompanied this code).
ohair@286 16 *
ohair@286 17 * You should have received a copy of the GNU General Public License version
ohair@286 18 * 2 along with this work; if not, write to the Free Software Foundation,
ohair@286 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
ohair@286 20 *
ohair@286 21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
ohair@286 22 * or visit www.oracle.com if you need additional information or have any
ohair@286 23 * questions.
ohair@286 24 */
ohair@286 25
ohair@286 26 package javax.xml.bind;
ohair@286 27
ohair@286 28 /**
ohair@286 29 * Encapsulate the location of a ValidationEvent.
ohair@286 30 *
ohair@286 31 * <p>
ohair@286 32 * The <tt>ValidationEventLocator</tt> indicates where the <tt>ValidationEvent
ohair@286 33 * </tt> occurred. Different fields will be set depending on the type of
ohair@286 34 * validation that was being performed when the error or warning was detected.
ohair@286 35 * For example, on-demand validation would produce locators that contained
ohair@286 36 * references to objects in the Java content tree while unmarshal-time
ohair@286 37 * validation would produce locators containing information appropriate to the
ohair@286 38 * source of the XML data (file, url, Node, etc).
ohair@286 39 *
ohair@286 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>
ohair@286 41 * @see Validator
ohair@286 42 * @see ValidationEvent
ohair@286 43 * @since JAXB1.0
ohair@286 44 */
ohair@286 45 public interface ValidationEventLocator {
ohair@286 46
ohair@286 47 /**
ohair@286 48 * Return the name of the XML source as a URL if available
ohair@286 49 *
ohair@286 50 * @return the name of the XML source as a URL or null if unavailable
ohair@286 51 */
ohair@286 52 public java.net.URL getURL();
ohair@286 53
ohair@286 54 /**
ohair@286 55 * Return the byte offset if available
ohair@286 56 *
ohair@286 57 * @return the byte offset into the input source or -1 if unavailable
ohair@286 58 */
ohair@286 59 public int getOffset();
ohair@286 60
ohair@286 61 /**
ohair@286 62 * Return the line number if available
ohair@286 63 *
ohair@286 64 * @return the line number or -1 if unavailable
ohair@286 65 */
ohair@286 66 public int getLineNumber();
ohair@286 67
ohair@286 68 /**
ohair@286 69 * Return the column number if available
ohair@286 70 *
ohair@286 71 * @return the column number or -1 if unavailable
ohair@286 72 */
ohair@286 73 public int getColumnNumber();
ohair@286 74
ohair@286 75 /**
ohair@286 76 * Return a reference to the object in the Java content tree if available
ohair@286 77 *
ohair@286 78 * @return a reference to the object in the Java content tree or null if
ohair@286 79 * unavailable
ohair@286 80 */
ohair@286 81 public java.lang.Object getObject();
ohair@286 82
ohair@286 83 /**
ohair@286 84 * Return a reference to the DOM Node if available
ohair@286 85 *
ohair@286 86 * @return a reference to the DOM Node or null if unavailable
ohair@286 87 */
ohair@286 88 public org.w3c.dom.Node getNode();
ohair@286 89
ohair@286 90 }

mercurial