Stax2 API 4.2.2 · org.codehaus.stax2.LocationInfo

Method Summary

Modifier and Type	Method and Description
public XMLStreamLocation2	Returns: Location of the next character reader will parse in the input source. getCurrentLocation() A method that returns the current location of the stream reader at the input source.
public long	Returns: Byte offset (== number of bytes reader so far) within the underlying stream, if the stream and stream reader are able to provide this (separate from the character offset, for variable-byte encodings); -1 if not. getEndingByteOffset() Method that can be used to get exact byte offset (number of bytes read from the stream right before getting to this location) in the stream that is pointed to by this reader, right after the end of the current event.
public long	Returns: Character offset (== number of bytes reader so far) within the underlying stream, if the stream and stream reader are able to provide this (separate from byte offset, for variable-byte encodings); -1 if not. getEndingCharOffset() Method that can be used to get exact character offset (number of chars read from the stream right before getting to this location) in the stream that is pointed to by this reader, right after the end of the current event.
public XMLStreamLocation2	Returns: Location right after the end of the current event (which will also be the start location of the next event, if any, or of EOF otherwise). getEndLocation() An optional method that either returns the location object that points the ending position of the current event, or null if implementation does not keep track of it (some may return only start location; and some no location at all).
public Location	getLocation()
public long	Returns: Byte offset (== number of bytes reader so far) within the underlying stream, if the stream and stream reader are able to provide this (separate from the character offset, for variable-byte encodings); -1 if not. getStartingByteOffset() Method that can be used to get exact byte offset (number of bytes read from the stream right before getting to this location) in the stream that is pointed to by this reader, right before the start of the current event.
public long	Returns: Character offset (== number of bytes reader so far) within the underlying stream, if the stream and stream reader are able to provide this (separate from byte offset, for variable-byte encodings); -1 if not. getStartingCharOffset() Method that can be used to get exact character offset (number of chars read from the stream right before getting to this location) in the stream that is pointed to by this reader, right before the start of the current event.
public XMLStreamLocation2	Returns: Location of the first character of the current event in the input source (which will also be the starting location of the following event, if any, or EOF if not), or null (if implementation does not track locations). getStartLocation() An optional method that either returns the location object that points the starting position of the current event, or null if implementation does not keep track of it (some may return only end location; and some no location at all).

Method Detail

getCurrentLocation	back to summary
public XMLStreamLocation2 getCurrentLocation() A method that returns the current location of the stream reader at the input source. This is somewhere between the start and end locations (inclusive), depending on how parser does it parsing (for non-lazy implementations it's always the end location; for others something else). Since this location information should always be accessible, no further parsing is to be done, and no exceptions can be thrown. Returns:XMLStreamLocation2 Location of the next character reader will parse in the input source.

getCurrentLocation

back to summary

public XMLStreamLocation2 getCurrentLocation()

A method that returns the current location of the stream reader at the input source. This is somewhere between the start and end locations (inclusive), depending on how parser does it parsing (for non-lazy implementations it's always the end location; for others something else).

Since this location information should always be accessible, no further parsing is to be done, and no exceptions can be thrown.

Returns:XMLStreamLocation2: Location of the next character reader will parse in the input source.

getEndingByteOffset back to summary

getEndingByteOffset	back to summary
public long getEndingByteOffset() throws XMLStreamException Method that can be used to get exact byte offset (number of bytes read from the stream right before getting to this location) in the stream that is pointed to by this reader, right after the end of the current event. Note this value MAY be the same as the one returned by `getEndingCharOffset`, but usually only for single-byte character streams (Ascii, ISO-Latin). Note for lazy-loading implementations, calling this method may require the underlying stream to be advanced and contents parsed; this is why it is possible that an exception be thrown. Returns:long Byte offset (== number of bytes reader so far) within the underlying stream, if the stream and stream reader are able to provide this (separate from the character offset, for variable-byte encodings); -1 if not.

public long getEndingByteOffset() throws XMLStreamException

Method that can be used to get exact byte offset (number of bytes read from the stream right before getting to this location) in the stream that is pointed to by this reader, right after the end of the current event.

Note

this value MAY be the same as the one returned by getEndingCharOffset, but usually only for single-byte character streams (Ascii, ISO-Latin).

Note

for lazy-loading implementations, calling this method may require the underlying stream to be advanced and contents parsed; this is why it is possible that an exception be thrown.

Returns:long: Byte offset (== number of bytes reader so far) within the underlying stream, if the stream and stream reader are able to provide this (separate from the character offset, for variable-byte encodings); -1 if not.

getEndingCharOffset back to summary

getEndingCharOffset	back to summary
public long getEndingCharOffset() throws XMLStreamException Method that can be used to get exact character offset (number of chars read from the stream right before getting to this location) in the stream that is pointed to by this reader, right after the end of the current event. Note this value MAY be the same as the one returned by `getEndingByteOffset`; this is the case for single-byte character streams (Ascii, ISO-Latin), as well as for streams for which byte offset information is not available (Readers, Strings). Note for lazy-loading implementations, calling this method may require the underlying stream to be advanced and contents parsed; this is why it is possible that an exception be thrown. Returns:long Character offset (== number of bytes reader so far) within the underlying stream, if the stream and stream reader are able to provide this (separate from byte offset, for variable-byte encodings); -1 if not.

public long getEndingCharOffset() throws XMLStreamException

Method that can be used to get exact character offset (number of chars read from the stream right before getting to this location) in the stream that is pointed to by this reader, right after the end of the current event.

Note

this value MAY be the same as the one returned by getEndingByteOffset; this is the case for single-byte character streams (Ascii, ISO-Latin), as well as for streams for which byte offset information is not available (Readers, Strings).

Note

for lazy-loading implementations, calling this method may require the underlying stream to be advanced and contents parsed; this is why it is possible that an exception be thrown.

Returns:long: Character offset (== number of bytes reader so far) within the underlying stream, if the stream and stream reader are able to provide this (separate from byte offset, for variable-byte encodings); -1 if not.

getEndLocation	back to summary
public XMLStreamLocation2 getEndLocation() throws XMLStreamException An optional method that either returns the location object that points the ending position of the current event, or null if implementation does not keep track of it (some may return only start location; and some no location at all). Note since some implementations may not yet know the end location (esp. ones that do lazy loading), this call may require further parsing. As a result, this method may throw a parsing or I/O errors. Returns:XMLStreamLocation2 Location right after the end of the current event (which will also be the start location of the next event, if any, or of EOF otherwise). Exceptions XMLStreamException: If the stream reader had to advance to the end of the event (to find the location), it may encounter a parsing (or I/O) error; if so, that gets thrown

getEndLocation

back to summary

public XMLStreamLocation2 getEndLocation() throws XMLStreamException

An optional method that either returns the location object that points the ending position of the current event, or null if implementation does not keep track of it (some may return only start location; and some no location at all).

Note

since some implementations may not yet know the end location (esp. ones that do lazy loading), this call may require further parsing. As a result, this method may throw a parsing or I/O errors.

Returns:XMLStreamLocation2

Location right after the end of the current event (which will also be the start location of the next event, if any, or of EOF otherwise).

Exceptions

XMLStreamException:: If the stream reader had to advance to the end of the event (to find the location), it may encounter a parsing (or I/O) error; if so, that gets thrown

getLocation	back to summary
public Location getLocation()

getStartingByteOffset back to summary

getStartingByteOffset	back to summary
public long getStartingByteOffset() Method that can be used to get exact byte offset (number of bytes read from the stream right before getting to this location) in the stream that is pointed to by this reader, right before the start of the current event. Note this value MAY be the same as the one returned by `getStartingCharOffset`, but usually only for single-byte character streams (Ascii, ISO-Latin). Returns:long Byte offset (== number of bytes reader so far) within the underlying stream, if the stream and stream reader are able to provide this (separate from the character offset, for variable-byte encodings); -1 if not.

public long getStartingByteOffset()

Method that can be used to get exact byte offset (number of bytes read from the stream right before getting to this location) in the stream that is pointed to by this reader, right before the start of the current event.

Note

this value MAY be the same as the one returned by getStartingCharOffset, but usually only for single-byte character streams (Ascii, ISO-Latin).

Returns:long: Byte offset (== number of bytes reader so far) within the underlying stream, if the stream and stream reader are able to provide this (separate from the character offset, for variable-byte encodings); -1 if not.

getStartingCharOffset back to summary

getStartingCharOffset	back to summary
public long getStartingCharOffset() Method that can be used to get exact character offset (number of chars read from the stream right before getting to this location) in the stream that is pointed to by this reader, right before the start of the current event. Note this value MAY be the same as the one returned by `getStartingByteOffset`; this is the case for single-byte character streams (Ascii, ISO-Latin), as well as for streams for which byte offset information is not available (Readers, Strings). Returns:long Character offset (== number of bytes reader so far) within the underlying stream, if the stream and stream reader are able to provide this (separate from byte offset, for variable-byte encodings); -1 if not.

public long getStartingCharOffset()

Note

this value MAY be the same as the one returned by getStartingByteOffset; this is the case for single-byte character streams (Ascii, ISO-Latin), as well as for streams for which byte offset information is not available (Readers, Strings).

Returns:long: Character offset (== number of bytes reader so far) within the underlying stream, if the stream and stream reader are able to provide this (separate from byte offset, for variable-byte encodings); -1 if not.

getStartLocation back to summary

getStartLocation	back to summary
public XMLStreamLocation2 getStartLocation() An optional method that either returns the location object that points the starting position of the current event, or null if implementation does not keep track of it (some may return only end location; and some no location at all). Note since it is assumed that the start location must either have been collected by now, or is not accessible (i.e. implementation [always] returns null), no exception is allowed to be throws, as no parsing should ever need to be done (unlike with `getEndLocation`). Returns:XMLStreamLocation2 Location of the first character of the current event in the input source (which will also be the starting location of the following event, if any, or EOF if not), or null (if implementation does not track locations).

public XMLStreamLocation2 getStartLocation()

An optional method that either returns the location object that points the starting position of the current event, or null if implementation does not keep track of it (some may return only end location; and some no location at all).

Note

since it is assumed that the start location must either have been collected by now, or is not accessible (i.e. implementation [always] returns null), no exception is allowed to be throws, as no parsing should ever need to be done (unlike with getEndLocation).

Returns:XMLStreamLocation2: Location of the first character of the current event in the input source (which will also be the starting location of the following event, if any, or EOF if not), or null (if implementation does not track locations).

public Interface LocationInfo

Method Summary

Method Detail