Module java.xml
Package org.w3c.dom

Interface DOMLocator


public interface DOMLocator
DOMLocator is an interface that describes a location (e.g. where an error occurred).

See also the Document Object Model (DOM) Level 3 Core Specification.

Since:
1.5, DOM Level 3
  • Method Summary

    Modifier and Type
    Method
    Description
    int
    The byte offset into the input source this locator is pointing to or -1 if there is no byte offset available.
    int
    The column number this locator is pointing to, or -1 if there is no column number available.
    int
    The line number this locator is pointing to, or -1 if there is no column number available.
    The node this locator is pointing to, or null if no node is available.
    The URI this locator is pointing to, or null if no URI is available.
    int
    The UTF-16, as defined in [Unicode] and Amendment 1 of [ISO/IEC 10646], offset into the input source this locator is pointing to or -1 if there is no UTF-16 offset available.
  • Method Details

    • getLineNumber

      int getLineNumber()
      The line number this locator is pointing to, or -1 if there is no column number available.
    • getColumnNumber

      int getColumnNumber()
      The column number this locator is pointing to, or -1 if there is no column number available.
    • getByteOffset

      int getByteOffset()
      The byte offset into the input source this locator is pointing to or -1 if there is no byte offset available.
    • getUtf16Offset

      int getUtf16Offset()
      The UTF-16, as defined in [Unicode] and Amendment 1 of [ISO/IEC 10646], offset into the input source this locator is pointing to or -1 if there is no UTF-16 offset available.
    • getRelatedNode

      Node getRelatedNode()
      The node this locator is pointing to, or null if no node is available.
    • getUri

      String getUri()
      The URI this locator is pointing to, or null if no URI is available.