PriorityMultiplexOutputStream

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

public class PriorityMultiplexOutputStream extends MultiplexOutputStream

saker.build.thirdparty.saker.util.io.PriorityMultiplexOutputStream

saker.build.thirdparty.saker.util.io.MultiplexOutputStream

java.io.OutputStream

java.lang.Object

java.io.Closeable

java.lang.AutoCloseable

java.io.Flushable

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

Output stream implementation that delegates its calls to a primary, and multiple secondary output streams.

This class acts as a simple forwarding output stream for the priority/primary output stream, and acts the same way as MultiplexOutputStream for the secondary streams.

Then a call is issued to this stream, it is forwarded to the priority stream. After that, all of the secondary streams are called for that operation. If any of the secondary streams throw an exception, it is not propagated to the caller, but can be retrieved later by calling getSecondaryException().

If the priority stream throws an exception during the call, it is propagated immediately, and the secondary streams are not called.

If the secondary streams threw an exception for a call, then they will not be called for future operations. Meaning, that if a secondary stream threw an exception, all of them may be in an inconsistent state.

This class closes all the output streams it was constructed with (both primary and secondary).

This stream class is not thread safe.

Constructors

protected	PriorityMultiplexOutputStream(OutputStream priorityStream) Creates a new instance only for a priority stream.
public	PriorityMultiplexOutputStream(OutputStream priorityStream, Collection<? extends OutputStream> secondarystreams) Creates a new instance for a priority stream and secondary streams.
public	PriorityMultiplexOutputStream(OutputStream priorityStream, OutputStream... secondarystreams) Creates a new instance for a priority stream and secondary streams.

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 IOException	getSecondaryException() Gets the exception that was thrown by the secondary streams.
public void	write(int b) Writes the specified byte to this output stream.
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: MultiplexOutputStream write
From: ByteSink readFrom
From: Object clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

protected PriorityMultiplexOutputStream(OutputStream priorityStream) throws NullPointerException

Creates a new instance only for a priority stream.

Generally, there is no use for using this constructor, as it makes the class add no extra functionality to the stream.

priorityStreamThe priority stream.

NullPointerExceptionIf the priority stream is null.

public PriorityMultiplexOutputStream(OutputStream priorityStream, Collection<? extends OutputStream> secondarystreams) throws NullPointerException

Creates a new instance for a priority stream and secondary streams.

If the argument secondary streams contain any null values, the stream may throw a NullPointerException later.

priorityStreamThe priority stream.

secondarystreamsThe secondary streams.

NullPointerExceptionIf any of the arguments are null.

public PriorityMultiplexOutputStream(OutputStream priorityStream, OutputStream... secondarystreams) throws NullPointerException

Creates a new instance for a priority stream and secondary streams.

If the argument secondary streams contain any null values, the stream may throw a NullPointerException later.

priorityStreamThe priority stream.

secondarystreamsThe secondary streams.

NullPointerExceptionIf any of the arguments are null.

public void close() throws IOException

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.

If the secondary streams throw an exception, it will be propagated.

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 IOException getSecondaryException()

Gets the exception that was thrown by the secondary streams.

The secondary exception or null it none was thrown.

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(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.