javax.xml.bind.ValidationEventLocator Maven / Gradle / Ivy
/*
* Copyright 2003, 2004 The Apache Software Foundation
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package javax.xml.bind;
import org.w3c.dom.Node;
/** The ValidationEventLocator is an abstract
* description of the place where a {@link javax.xml.bind.ValidationEvent}
* occurred.
* Depending on the source or target media (Unmarshalling, or Unmarshalling)
* or the object being validated, you will most probably find that different
* fields of the ValidationEventHandler are set. For example,
* if you are using a {@link org.xml.sax.ContentHandler}, you will most
* probably find that those fields are set, which are common to a
* {@link org.xml.sax.Locator}.
*
* @see javax.xml.bind.ValidationEvent
* @since JAXB1.0
* @author JSR-31
*/
public interface ValidationEventLocator {
/** Returns a URL related to the validation event, if available.
* For example, when parsing an {@link org.xml.sax.InputSource}, this
* might be the URL given by {@link org.xml.sax.InputSource#getSystemId()}.
* @return The validation event URL, if available, or null.
*/
public java.net.URL getURL();
/** Returns a byte offset related to the validation event, if
* available. For example, when parsing an {@link java.io.InputStream},
* this might be the position where the event occurred.
* @return Byte offset, if available, or -1.
*/
public int getOffset();
/** Returns a line number related to the validation event, if
* available. For example, when parsing an {@link java.io.InputStream},
* this might be the line, in which the event occurred.
* @return Line number, if available, or -1.
*/
public int getLineNumber();
/** Returns a column number related to the validation event, if
* available. For example, when parsing an {@link java.io.InputStream},
* this might be the column, in which the event occurred.
* @return Column number, if available, or -1.
*/
public int getColumnNumber();
/** Returns an object in the JAXB objects content tree related
* to the validation event. Usually this is the invalid object or
* child object.
* @return Part of a JAXB object tree, if available, or null.
*/
public java.lang.Object getObject();
/** Returns a DOM node related to the validation event. For
* example, this might be an element node with a missing attribute.
* It might as well be an attribute node with an invalid value.
* @return Invalid node, if available, or null.
*/
public Node getNode();
}