info.bioinfweb.commons.io

Class PeekReader.ReadResult

java.lang.Object

info.bioinfweb.commons.io.PeekReader.ReadResult

Enclosing class:

PeekReader

public static class PeekReader.ReadResult
extends java.lang.Object

Stores information about the result of a read operation, as it is returned by some methods of PeekReader.

Since:

1.2.0

Author:

Ben Stöver

Constructor Summary

Constructors

Constructor and Description
ReadResult(java.lang.CharSequence sequence, boolean completelyRead) Creates a new instance of this class

Method Summary

Modifier and Type	Method and Description
java.lang.CharSequence	getSequence() The character sequence that was read from the underlying data source.
boolean	isCompletelyRead() Allows to determine whether the specified maximum number of characters were read or all characters were read as intended.

Methods inherited from class java.lang.Object

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

Constructor Detail

ReadResult

public ReadResult(java.lang.CharSequence sequence,
                  boolean completelyRead)

Creates a new instance of this class

Parameters:

sequence - the character sequence that was read

completelyRead - Specify true here if the returned sequence contains all characters that should have been read or false if reading was aborted because the maximum number of characters was read.

Method Detail

getSequence

public java.lang.CharSequence getSequence()

The character sequence that was read from the underlying data source.

Returns:

the read characters

isCompletelyRead

public boolean isCompletelyRead()

Allows to determine whether the specified maximum number of characters were read or all characters were read as intended.

Returns:

true if the returned sequence contains all characters that should have been read or false if reading was aborted because the maximum number of characters was reached