DOM Level 3 API: Interface DOMLocator

Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.apache.xerces.dom3
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.
`org.w3c.dom.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 org.w3c.dom.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.

Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 1999-2004 Apache XML Project. All Rights Reserved.