io.starter.toolkit

Class IndirectOutputStream

java.lang.Object

java.io.OutputStream

io.starter.toolkit.IndirectOutputStream

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

public class IndirectOutputStream
extends OutputStream

An IndirectOutputStream forwards all requests unmodified to another output stream which may be changed at runtime. By default an IOException will be thrown if no sink is configured when a request is received. The stream may be configured to drop such requests instead.

Constructor Summary

Constructors

Constructor and Description
IndirectOutputStream() Creates a new IndirectOutputStream with no sink which fails when no sink is present.
IndirectOutputStream(OutputStream sink) Creates a new IndirectOutputStream with the given sink which fails when no sink is present.
IndirectOutputStream(OutputStream sink, boolean discard) Creates a new IndirectOutputStream with the given sink and behavior when no sink is present.

Method Summary

Modifier and Type	Method and Description
void	close()
boolean	discardOnNoSink() Gets the current behavior when no wink is present.
void	discardOnNoSink(boolean discard) Sets the behavior when no sink is present.
void	flush()
OutputStream	getSink() Gets the currently configured sink.
void	setSink(OutputStream sink) Sets the stream to which requests are forwarded.
void	write(byte[] b)
void	write(byte[] b, int off, int len)
void	write(int b)

Methods inherited from class java.lang.Object

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

Constructor Detail

IndirectOutputStream

public IndirectOutputStream()

Creates a new IndirectOutputStream with no sink which fails when no sink is present.

IndirectOutputStream

public IndirectOutputStream(OutputStream sink)

Creates a new IndirectOutputStream with the given sink which fails when no sink is present.

Parameters:

sink - the initial sink

IndirectOutputStream

public IndirectOutputStream(OutputStream sink,
                            boolean discard)

Creates a new IndirectOutputStream with the given sink and behavior when no sink is present.

Parameters:

sink - the initial sink

discard - whether to discard requests when no sink is present

Method Detail

getSink

public OutputStream getSink()

Gets the currently configured sink.

Returns:

the stream to which requests are currently being forwarded or null if no sink present

setSink

public void setSink(OutputStream sink)

Sets the stream to which requests are forwarded.

Parameters:

sink - the stream to which requests should be forwarded or null to remove the current sink

discardOnNoSink

public boolean discardOnNoSink()

Gets the current behavior when no wink is present.

Returns:

whether requests will be discarded when no sink is present

discardOnNoSink

public void discardOnNoSink(boolean discard)

Sets the behavior when no sink is present.

Parameters:

discard - whether to discard requests when no sink is present

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 Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class OutputStream

Throws:

IOException