public interface

Location

javax.xml.stream.Location

Class Overview

Provides information on the location of an event. All the information provided by a Location is optional. For example an application may only report line numbers.

Summary

Public Methods
abstract int getCharacterOffset()
Return the byte or character offset into the input source this location is pointing to.
abstract int getColumnNumber()
Return the column number where the current event ends, returns -1 if none is available.
abstract int getLineNumber()
Return the line number where the current event ends, returns -1 if none is available.
abstract String getPublicId()
Returns the public ID of the XML
abstract String getSystemId()
Returns the system ID of the XML

Public Methods

public abstract int getCharacterOffset ()

Return the byte or character offset into the input source this location is pointing to. If the input source is a file or a byte stream then this is the byte offset into that stream, but if the input source is a character media then the offset is the character offset. Returns -1 if there is no offset available.

Returns
  • the current offset

public abstract int getColumnNumber ()

Return the column number where the current event ends, returns -1 if none is available.

Returns
  • the current column number

public abstract int getLineNumber ()

Return the line number where the current event ends, returns -1 if none is available.

Returns
  • the current line number

public abstract String getPublicId ()

Returns the public ID of the XML

Returns
  • the public ID, or null if not available

public abstract String getSystemId ()

Returns the system ID of the XML

Returns
  • the system ID, or null if not available