info.bioinfweb.commons.io

Interface StreamLocationProvider

All Known Implementing Classes:

PeekReader, StreamLocation

public interface StreamLocationProvider

Interface to be implemented by classes (e.g. readers) that offer properties to determine their current location in a stream.

For compatibility, the properties in this interface have the same names as in Location.

Since:

1.2.0

Author:

Ben Stöver

Method Summary

Modifier and Type	Method and Description
long	getCharacterOffset() Returns the number of characters that have been read from this instance since the beginning of the underlying stream.
long	getColumnNumber() Returns the column of the current line, where the cursor of this instance is currently located.
long	getLineNumber() Returns the number of the line in the stream, where the cursor of this instance is currently located.

Method Detail

getCharacterOffset

long getCharacterOffset()

Returns the number of characters that have been read from this instance since the beginning of the underlying stream.

Note that due to the buffering of this class, this value may differ from the number of characters that have been read from the underlying stream.

Returns:

the number of characters that have currently been read from this reader instance

getLineNumber

long getLineNumber()

Returns the number of the line in the stream, where the cursor of this instance is currently located.

This reader keeps track of the line number by monitoring each line separator that is read. Supported line separators are '\n', '\r' or '\r\n'.

Returns:

the current line number

getColumnNumber

long getColumnNumber()

Returns the column of the current line, where the cursor of this instance is currently located.

Returns:

the current column number in the current line

See Also:

getLineNumber()