Class LimitReader
java.lang.Object
java.io.Reader
org.apache.derby.iapi.services.io.LimitReader
- All Implemented Interfaces:
Closeable
,AutoCloseable
,Readable
,Limit
A Reader that provides methods to limit the range that
can be read from the reader.
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionLimitReader
(Reader reader) Construct a LimitReader and call the clearLimit() method. -
Method Summary
Modifier and TypeMethodDescriptionint
Clear any limit set by setLimit.void
close()
final int
getLimit()
return limit of the stream that can be read without throwing EOFExceptionint
read()
int
read
(char[] c, int off, int len) void
setLimit
(int length) Set the limit of the stream that can be read.long
skip
(long count) Methods inherited from class java.io.Reader
mark, markSupported, nullReader, read, read, ready, reset, transferTo
-
Field Details
-
remainingCharacters
private int remainingCharacters -
limitInPlace
private boolean limitInPlace -
reader
-
-
Constructor Details
-
LimitReader
Construct a LimitReader and call the clearLimit() method.
-
-
Method Details
-
read
- Overrides:
read
in classReader
- Throws:
IOException
-
read
- Specified by:
read
in classReader
- Throws:
IOException
-
skip
- Overrides:
skip
in classReader
- Throws:
IOException
-
close
- Specified by:
close
in interfaceAutoCloseable
- Specified by:
close
in interfaceCloseable
- Specified by:
close
in classReader
- Throws:
IOException
-
setLimit
public void setLimit(int length) Set the limit of the stream that can be read. After this call up to and including length characters can be read from or skipped in the stream. Any attempt to read more than length characters will result in an EOFException -
getLimit
public final int getLimit()return limit of the stream that can be read without throwing EOFException- Returns:
- the remaining characters left to be read from the stream
-
clearLimit
public int clearLimit()Clear any limit set by setLimit. After this call no limit checking will be made on any read until a setLimit()) call is made.- Specified by:
clearLimit
in interfaceLimit
- Returns:
- the number of bytes within the limit that have not been read. -1 if not limit was set.
-