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.
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 Details

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.

getColumnNumber

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

getLineNumber

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

getRelatedNode

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

getUri

public String getUri()
The URI this locator is pointing to, or null if no URI is 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.

* Copyright (c) 2004 World Wide Web Consortium, * * (Massachusetts Institute of Technology, European Research Consortium for * Informatics and Mathematics, Keio University). All Rights Reserved. This * work is distributed under the W3C(r) Software License [1] in the hope that * it will be useful, but WITHOUT ANY WARRANTY; without even the implied * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. * * [1] http://www.w3.org/Consortium/Legal/2002/copyright-software-20021231