Package eu.cloudnetservice.common.io

Class ListenableOutputStream<O extends OutputStream>

java.lang.Object

java.io.OutputStream

eu.cloudnetservice.common.io.ListenableOutputStream<O>

Type Parameters:

O - the type of the wrapped output stream.

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

public final class ListenableOutputStream<O extends OutputStream>
extends OutputStream

An output stream implementation that holds a listener to call when the stream gets closed. The listener function can for example be used to actually commit an action to the real underlying file system.

Since:

4.0

Field Summary

Fields

Modifier and Type	Field	Description
private final io.vavr.CheckedConsumer<O>	closeListener
private final O	wrapped

Constructor Summary

Constructors

Constructor	Description
ListenableOutputStream(O wrapped, @NonNull io.vavr.CheckedConsumer<O> closeListener)	Constructs a new listenable output stream using the given stream as the target and the given close listener to call when the stream gets closed.

Method Summary

Modifier and Type	Method	Description
void	close()	Calls the given close listener and then closes the wrapped output stream, rethrowing any exception that was thrown by either of these two actions.
void	flush()
void	write(byte @NonNull [] b)
void	write(byte @NonNull [] 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

Field Details

wrapped

private final O extends OutputStream wrapped

closeListener

private final io.vavr.CheckedConsumer<O extends OutputStream> closeListener

Constructor Details

ListenableOutputStream

public ListenableOutputStream(@NonNull
 O wrapped,
 @NonNull
 @NonNull io.vavr.CheckedConsumer<O> closeListener)

Constructs a new listenable output stream using the given stream as the target and the given close listener to call when the stream gets closed.

Parameters:

wrapped - the stream to wrap and delegate all write calls to.

closeListener - the close listener to call when this stream gets closed.

Throws:

NullPointerException - if the given wrapped stream or close listener is null.

Method Details

write

public void write(int b)
           throws IOException

Specified by:

write in class OutputStream

Throws:

IOException

write

public void write(byte @NonNull [] b)
           throws IOException

Overrides:

write in class OutputStream

Throws:

IOException

write

public void write(byte @NonNull [] 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

Calls the given close listener and then closes the wrapped output stream, rethrowing any exception that was thrown by either of these two actions.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class OutputStream

Throws:

IOException