Interface ValidationEventLocator

All Known Implementing Classes:
ValidationEventLocatorImpl

public interface ValidationEventLocator
Encapsulate the location of a ValidationEvent.

The ValidationEventLocator indicates where the ValidationEvent occurred. Different fields will be set depending on the type of validation that was being performed when the error or warning was detected. For example, on-demand validation would produce locators that contained references to objects in the Java content tree while unmarshal-time validation would produce locators containing information appropriate to the source of the XML data (file, url, Node, etc.).

Author:
  • Ryan Shoemaker, Sun Microsystems, Inc.
  • Kohsuke Kawaguchi, Sun Microsystems, Inc.
  • Joe Fialli, Sun Microsystems, Inc.
See Also:
  • Method Summary Link icon

    Modifier and Type
    Method
    Description
    int
    Return the column number if available
    int
    Return the line number if available
    Return a reference to the DOM Node if available
    Return a reference to the object in the Java content tree if available
    int
    Return the byte offset if available
    Return the name of the XML source as a URL if available
  • Method Details Link icon

    • getURL Link icon

      URL getURL()
      Return the name of the XML source as a URL if available
      Returns:
      the name of the XML source as a URL or null if unavailable
    • getOffset Link icon

      int getOffset()
      Return the byte offset if available
      Returns:
      the byte offset into the input source or -1 if unavailable
    • getLineNumber Link icon

      int getLineNumber()
      Return the line number if available
      Returns:
      the line number or -1 if unavailable
    • getColumnNumber Link icon

      int getColumnNumber()
      Return the column number if available
      Returns:
      the column number or -1 if unavailable
    • getObject Link icon

      Object getObject()
      Return a reference to the object in the Java content tree if available
      Returns:
      a reference to the object in the Java content tree or null if unavailable
    • getNode Link icon

      Node getNode()
      Return a reference to the DOM Node if available
      Returns:
      a reference to the DOM Node or null if unavailable