Added in API level 8

DOMLocator

public interface DOMLocator

org.w3c.dom.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.

Summary

Public methods

abstract int getByteOffset()

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

abstract int getColumnNumber()

The column number this locator is pointing to, or -1 if there is no column number available.

abstract int getLineNumber()

The line number this locator is pointing to, or -1 if there is no column number available.

abstract Node getRelatedNode()

The node this locator is pointing to, or null if no node is available.

abstract String getUri()

The URI this locator is pointing to, or null if no URI is available.

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

Public methods

getByteOffset

Added in API level 8
public abstract int getByteOffset ()

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

Returns
int

getColumnNumber

Added in API level 8
public abstract int getColumnNumber ()

The column number this locator is pointing to, or -1 if there is no column number available.

Returns
int

getLineNumber

Added in API level 8
public abstract int getLineNumber ()

The line number this locator is pointing to, or -1 if there is no column number available.

Returns
int

getRelatedNode

Added in API level 8
public abstract Node getRelatedNode ()

The node this locator is pointing to, or null if no node is available.

Returns
Node

getUri

Added in API level 8
public abstract String getUri ()

The URI this locator is pointing to, or null if no URI is available.

Returns
String

getUtf16Offset

Added in API level 8
public abstract 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.

Returns
int