javax.xml.stream
Interface Location


public interface Location

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.


Method Summary
 int getCharacterOffset()
          Return the byte or character offset into the input source this location is pointing to.
 int getColumnNumber()
          Return the column number where the current event ends, returns -1 if none is available.
 int getLineNumber()
          Return the line number where the current event ends, returns -1 if none is available.
 java.lang.String getLocationURI()
          The URI this Location is pointing to, or null if no URI is available
 

Method Detail

getLineNumber

public int getLineNumber()
Return the line number where the current event ends, returns -1 if none is available.


getColumnNumber

public int getColumnNumber()
Return the column number where the current event ends, returns -1 if none is available.


getCharacterOffset

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


getLocationURI

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