com.github.robtimus.io.stream

Class LimitReader

java.lang.Object

java.io.Reader

com.github.robtimus.io.stream.LimitReader

All Implemented Interfaces:

Closeable, AutoCloseable, Readable

public final class LimitReader
extends Reader

A reader that limits the number of characters that can be read from another reader.

If a read call causes the limit to be exceeded and the limit reader is configured to throw an exception, the call will lead to a LimitExceededException to be thrown. Every subsequent read call will return -1.

Author:

Rob Spoor

Field Summary

Fields inherited from class java.io.Reader

lock

Constructor Summary

Constructors

Constructor and Description
LimitReader(Reader reader, long limit) Creates a new limiting reader.
LimitReader(Reader reader, long limit, LimitExceededStrategy strategy) Creates a new limiting reader.

Method Summary

Modifier and Type	Method and Description
void	close()
void	mark(int readAheadLimit)
boolean	markSupported()
int	read()
int	read(char[] cbuf, int off, int len)
boolean	ready()
void	reset()
long	skip(long n)

Methods inherited from class java.io.Reader

read, read

Methods inherited from class java.lang.Object

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

Constructor Detail

LimitReader

public LimitReader(Reader reader,
                   long limit)

Creates a new limiting reader. This reader will discard any excess characters.

Parameters:

reader - The reader for which to limit the number of characters that can be read.

limit - The maximum number of characters that can be read.

Throws:

NullPointerException - If the given reader is null.

IllegalArgumentException - If the given limit is negative.

LimitReader

public LimitReader(Reader reader,
                   long limit,
                   LimitExceededStrategy strategy)

Creates a new limiting reader.

Parameters:

reader - The reader for which to limit the number of characters that can be read.

limit - The maximum number of characters that can be read.

strategy - The strategy to follow when the maximum number of characters has exceeded.

Throws:

NullPointerException - If the given reader or strategy is null.

IllegalArgumentException - If the given limit is negative.

Method Detail

read

public int read()
         throws IOException

Overrides:

read in class Reader

Throws:

IOException

read

public int read(char[] cbuf,
                int off,
                int len)
         throws IOException

Specified by:

read in class Reader

Throws:

IOException

skip

public long skip(long n)
          throws IOException

Overrides:

skip in class Reader

Throws:

IOException

ready

public boolean ready()
              throws IOException

Overrides:

ready in class Reader

Throws:

IOException

markSupported

public boolean markSupported()

Overrides:

markSupported in class Reader

mark

public void mark(int readAheadLimit)
          throws IOException

Overrides:

mark in class Reader

Throws:

IOException

reset

public void reset()
           throws IOException

Overrides:

reset in class Reader

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in class Reader

Throws:

IOException