com.github.robtimus.io.stream

Class LimitOutputStream

java.lang.Object

java.io.OutputStream

com.github.robtimus.io.stream.LimitOutputStream

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

public final class LimitOutputStream
extends OutputStream

An output stream that limits the number of bytes that can be written to another output stream.

If a write call causes the limit to be exceeded and the limit output stream is configured to throw an exception, the call will lead to a LimitExceededException to be thrown.

Author:

Rob Spoor

Constructor Summary

Constructors

Constructor and Description
LimitOutputStream(OutputStream output, long limit) Creates a new limit output stream.
LimitOutputStream(OutputStream output, long limit, LimitExceededStrategy strategy) Creates a new limit output stream.

Method Summary

Modifier and Type	Method and Description
void	close()
void	flush()
void	write(byte[] b, int off, int len)
void	write(int c)

Methods inherited from class java.io.OutputStream

write

Methods inherited from class java.lang.Object

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

Constructor Detail

LimitOutputStream

public LimitOutputStream(OutputStream output,
                         long limit)

Creates a new limit output stream. This output stream will discard any excess bytes.

Parameters:

output - The output stream for which to limit the number of bytes that can be written.

limit - The maximum number of bytes that can be written.

Throws:

NullPointerException - If the given output stream is null.

IllegalArgumentException - If the given limit is negative.

LimitOutputStream

public LimitOutputStream(OutputStream output,
                         long limit,
                         LimitExceededStrategy strategy)

Creates a new limit output stream.

Parameters:

output - The output stream for which to limit the number of bytes that can be written.

limit - The maximum number of bytes that can be written.

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

Throws:

NullPointerException - If the given output stream or strategy is null.

IllegalArgumentException - If the given limit is negative.

Method Detail

write

public void write(int c)
           throws IOException

Specified by:

write in class OutputStream

Throws:

IOException

write

public void write(byte[] b,
                  int off,
                  int len)
           throws IOException

Overrides:

write in class OutputStream

Throws:

IOException

flush

public void flush()
           throws IOException

Specified by:

flush in interface Flushable

Overrides:

flush in class OutputStream

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class OutputStream

Throws:

IOException