com.github.robtimus.io.stream

Class CapturingOutputStream

java.lang.Object

java.io.OutputStream

com.github.robtimus.io.stream.CapturingOutputStream

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

public final class CapturingOutputStream
extends OutputStream

An output stream that captures the content it writes. This is a simplified version of TeeOutputStream.

Author:

Rob Spoor

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CapturingOutputStream.Config Configuration for capturing output streams.

Constructor Summary

Constructors

Constructor and Description
CapturingOutputStream(OutputStream output, CapturingOutputStream.Config config) Creates a new capturing output stream.

Method Summary

Modifier and Type	Method and Description
byte[]	captured() Returns the contents that have been captured.
String	captured(Charset charset) Returns the contents that have been captured, as a string.
void	close()
static CapturingOutputStream.Config.Builder	config() Creates a builder for capturing output stream configurations.
void	done() Marks the capturing as done.
void	flush()
boolean	isClosed() Returns whether or not this output stream has been closed.
long	totalBytes() Returns the total number of bytes that have been written.
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

CapturingOutputStream

public CapturingOutputStream(OutputStream output,
                             CapturingOutputStream.Config config)

Creates a new capturing output stream.

Parameters:

output - The output stream to capture from.

config - The configuration to use.

Throws:

NullPointerException - If the given output stream or config is null.

Method Detail

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

done

public void done()

Marks the capturing as done. This method should be called in cases where this output stream cannot be closed, but the done callback still needs to be executed.

captured

public byte[] captured()

Returns the contents that have been captured.

Returns:

An array with the bytes that have been captured.

captured

public String captured(Charset charset)

Returns the contents that have been captured, as a string.

Parameters:

charset - The charset to use.

Returns:

A string representing the contents that have been captured.

totalBytes

public long totalBytes()

Returns the total number of bytes that have been written.

Returns:

The total number of bytes that have been written.

isClosed

public boolean isClosed()

Returns whether or not this output stream has been closed.

Returns:

true if this output stream has been closed, or false otherwise.

config

public static CapturingOutputStream.Config.Builder config()

Creates a builder for capturing output stream configurations.

Returns:

The created builder.