org.omnifaces.io

Class ResettableBufferedOutputStream

java.lang.Object

java.io.OutputStream

org.omnifaces.io.ResettableBufferedOutputStream

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable, ResettableBuffer

public class ResettableBufferedOutputStream
extends OutputStream
implements ResettableBuffer

This resettable buffered output stream will buffer everything until the given buffer size, regardless of flush calls. Only when the buffer size is exceeded, or when close is called, then the buffer will be actually flushed.

There is a reset() method which enables the developer to reset the buffer, as long as it's not flushed yet, which can be determined by isResettable().

Author:

Bauke Scholtz

See Also:

ResettableBufferedWriter

Constructor Summary

Constructors

Constructor and Description
ResettableBufferedOutputStream(OutputStream output, int bufferSize) Construct a new resettable buffered output stream which wraps the given output stream and forcibly buffers everything until the given buffer size, regardless of flush calls.

Method Summary

Modifier and Type	Method and Description
void	close()
void	flush()
boolean	isResettable() Returns true if buffer can be reset.
void	reset() Perform a buffer reset.
void	write(byte[] bytes)
void	write(byte[] bytes, int offset, int length)
void	write(int b)

Methods inherited from class java.lang.Object

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

Constructor Detail

ResettableBufferedOutputStream

public ResettableBufferedOutputStream(OutputStream output,
                                      int bufferSize)

Construct a new resettable buffered output stream which wraps the given output stream and forcibly buffers everything until the given buffer size, regardless of flush calls.

Parameters:

output - The wrapped output stream .

bufferSize - The buffer size.

Method Detail

write

public void write(int b)
           throws IOException

Specified by:

write in class OutputStream

Throws:

IOException

write

public void write(byte[] bytes)
           throws IOException

Overrides:

write in class OutputStream

Throws:

IOException

write

public void write(byte[] bytes,
                  int offset,
                  int length)
           throws IOException

Overrides:

write in class OutputStream

Throws:

IOException

reset

public void reset()

Description copied from interface: ResettableBuffer

Perform a buffer reset.

Specified by:

reset in interface ResettableBuffer

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

isResettable

public boolean isResettable()

Description copied from interface: ResettableBuffer

Returns true if buffer can be reset.

Specified by:

isResettable in interface ResettableBuffer

Returns:

true if buffer can be reset, otherwise false.