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:
DOM Level 3

Method Summary
 int getByteOffset()
          The byte offset into the input source this locator is pointing to or -1 if there is no byte offset available.
 int getColumnNumber()
          The column number this locator is pointing to, or -1 if there is no column number available.
 int getLineNumber()
          The line number this locator is pointing to, or -1 if there is no column number available.
 Node getRelatedNode()
          The node this locator is pointing to, or null if no node is available.
 java.lang.String getUri()
          The URI this locator is pointing to, or null if no URI is available.
 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.
 

Method Detail

getLineNumber

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

getColumnNumber

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

getByteOffset

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

getUtf16Offset

public 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

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

getUri

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


Copyright 2006 Apache XML Project. All Rights Reserved.