DynamicFilterByteSink

package saker.build.thirdparty.saker.util.io

public class DynamicFilterByteSink extends OutputStream implements ByteSink

saker.build.thirdparty.saker.util.io.DynamicFilterByteSink

java.io.OutputStream

java.lang.Object

java.io.Closeable

java.lang.AutoCloseable

java.io.Flushable

saker.build.thirdparty.saker.util.io.ByteSink

ByteSink and OutputStream implementation that dynamically chooses the actual output for each write operation.

This class forwards its write operations to a ByteSink that is choosen using the given function at construction time. If a write opperation is requested, the function is called, which can choose the stream to execute the write operation on. If the function returns null, the fallback ByteSink will be used to complete the operation.

The chooser function can decide arbitrarily, but an useful implementation is that it returns a stream based on some thread local state.

Closing this stream will not close the fallback sink, or any choosen outputs by the chooser function.

DynamicFilterByteSource

Constructors

public	DynamicFilterByteSink(Supplier<? extends ByteSink> sinkProvider, ByteSink fallbackSink) Creates a new instance.

Methods

public void	close() Closes this output stream and releases any system resources associated with this stream.
public void	flush() Flushes this output stream and forces any buffered output bytes to be written out.
public ByteSink	getFallbackSink() Gets the fallback byte sink that is used when the sink chooser function fails to find an output.
public void	write(int b) Writes the specified byte to this output stream.
public void	write(ByteArrayRegion buf) Writes the bytes contained in the argument byte array to the byte sink.
public void	write(byte[] b) Writes `b.length` bytes from the specified byte array to this output stream.
public void	write(byte[] b, int off, int len) Writes `len` bytes from the specified byte array starting at offset `off` to this output stream.

Inherited methods
From: ByteSink readFrom
From: Object clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

public DynamicFilterByteSink(Supplier<? extends ByteSink> sinkProvider, ByteSink fallbackSink) throws NullPointerException

Creates a new instance.

sinkProviderThe sink provider function which is called when write operations are issued.

fallbackSinkThe fallback sink which is used when the sink provider fails to get an output.

NullPointerExceptionIf any of the arguments are null.

public void close() throws IOException

Overridden from: OutputStream

Closes this output stream and releases any system resources associated with this stream. The general contract of close is that it closes the output stream. A closed stream cannot perform output operations and cannot be reopened.

The close method of OutputStream does nothing.

IOExceptionif an I/O error occurs.

public void flush() throws IOException

Overridden from: OutputStream

Flushes this output stream and forces any buffered output bytes to be written out. The general contract of flush is that calling it is an indication that, if any bytes previously written have been buffered by the implementation of the output stream, such bytes should immediately be written to their intended destination.

If the intended destination of this stream is an abstraction provided by the underlying operating system, for example a file, then flushing the stream guarantees only that bytes previously written to the stream are passed to the operating system for writing; it does not guarantee that they are actually written to a physical device such as a disk drive.

The flush method of OutputStream does nothing.

IOExceptionif an I/O error occurs.

public ByteSink getFallbackSink()

Gets the fallback byte sink that is used when the sink chooser function fails to find an output.

The fallback sink.

public void write(int b) throws IOException

Overridden from: OutputStream

Writes the specified byte to this output stream. The general contract for write is that one byte is written to the output stream. The byte to be written is the eight low-order bits of the argument b. The 24 high-order bits of b are ignored.

Subclasses of OutputStream must provide an implementation for this method.

bthe byte.

IOExceptionif an I/O error occurs. In particular, an IOException may be thrown if the output stream has been closed.

public void write(ByteArrayRegion buf) throws IOException

Overridden from: ByteSink

Writes the bytes contained in the argument byte array to the byte sink.

This method works similarly to OutputStream.write(byte[], int, int).

bufThe bytes to write.

IOExceptionIn case of I/O error.

public void write(byte[] b) throws IOException

Overridden from: OutputStream

Writes b.length bytes from the specified byte array to this output stream. The general contract for write(b) is that it should have exactly the same effect as the call write(b, 0, b.length).

bthe data.

IOExceptionif an I/O error occurs.

OutputStream.write(byte[], int, int)

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

Overridden from: OutputStream

Writes len bytes from the specified byte array starting at offset off to this output stream. The general contract for write(b, off, len) is that some of the bytes in the array b are written to the output stream in order; element b[off] is the first byte written and b[off+len-1] is the last byte written by this operation.

The write method of OutputStream calls the write method of one argument on each of the bytes to be written out. Subclasses are encouraged to override this method and provide a more efficient implementation.

If b is null, a NullPointerException is thrown.

If off is negative, or len is negative, or off+len is greater than the length of the array b, then an IndexOutOfBoundsException is thrown.

bthe data.

offthe start offset in the data.

lenthe number of bytes to write.

IOExceptionif an I/O error occurs. In particular, an IOException is thrown if the output stream is closed.