Package org.apache.druid.io

Class LimitedOutputStream

java.lang.Object

java.io.OutputStream

org.apache.druid.io.LimitedOutputStream

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

public class LimitedOutputStream
extends OutputStream

An OutputStream that limits how many bytes can be written. Throws IOException if the limit is exceeded. *Not* thread-safe.

Constructor Summary

Constructors

Constructor	Description
LimitedOutputStream(OutputStream out, long limit, Function<Long,String> exceptionMessageFn)	Create a bytes-limited output stream.

Method Summary

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

Methods inherited from class java.io.OutputStream

nullOutputStream

Methods inherited from class java.lang.Object

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

Constructor Details

LimitedOutputStream

public LimitedOutputStream(OutputStream out,
 long limit,
 Function<Long,String> exceptionMessageFn)

Create a bytes-limited output stream.

Parameters:

out - output stream to wrap

limit - bytes limit

exceptionMessageFn - function for generating an exception message for an IOException, given the limit.

Method Details

write

public void write(int b)
           throws IOException

Specified by:

write in class OutputStream

Throws:

IOException

write

public void write(byte[] b)
           throws IOException

Overrides:

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 AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class OutputStream

Throws:

IOException

toByteArray

public byte[] toByteArray()