info.bioinfweb.commons.io

Class StreamLocation

java.lang.Object

info.bioinfweb.commons.io.StreamLocation

All Implemented Interfaces:

StreamLocationProvider

public class StreamLocation
extends java.lang.Object
implements StreamLocationProvider

A read only implementation of StreamLocationProvider, which can be used to store a static location.

Since:

1.2.0

Author:

Ben Stöver

See Also:

StreamLocationProviderOffsetComparator

Constructor Summary

Constructors

Constructor and Description
StreamLocation(javax.xml.stream.Location location)
StreamLocation(long characterOffset, long lineNumber, long columnNumber)
StreamLocation(StreamLocationProvider locationProvider)

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj) Note that this method will only return true, if the other object is also an instance of this class or an inherited class.
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.
int	hashCode()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

StreamLocation

public StreamLocation(long characterOffset,
                      long lineNumber,
                      long columnNumber)

StreamLocation

public StreamLocation(StreamLocationProvider locationProvider)

StreamLocation

public StreamLocation(javax.xml.stream.Location location)

Method Detail

getCharacterOffset

public long getCharacterOffset()

Description copied from interface: StreamLocationProvider

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.

Specified by:

getCharacterOffset in interface StreamLocationProvider

Returns:

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

getLineNumber

public long getLineNumber()

Description copied from interface: StreamLocationProvider

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

Specified by:

getLineNumber in interface StreamLocationProvider

Returns:

the current line number

getColumnNumber

public long getColumnNumber()

Description copied from interface: StreamLocationProvider

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

Specified by:

getColumnNumber in interface StreamLocationProvider

Returns:

the current column number in the current line

See Also:

StreamLocationProvider.getLineNumber()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Note that this method will only return true, if the other object is also an instance of this class or an inherited class. It will not return true if the passed object is a different implementation of StreamLocationProvider, since it is not guaranteed that such implementations would have a symmetric equals method.

Overrides:

equals in class java.lang.Object

See Also:

Object.equals(java.lang.Object)