com.github.robtimus.io.stream

Class CapturingWriter

java.lang.Object

java.io.Writer

com.github.robtimus.io.stream.CapturingWriter

All Implemented Interfaces:

Closeable, Flushable, Appendable, AutoCloseable

public final class CapturingWriter
extends Writer

A writer that captures the content it writes. This is a simplified version of TeeWriter and ProxyCollectionWriter.

Author:

Rob Spoor

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CapturingWriter.Config Configuration for capturing writers.

Field Summary

Fields inherited from class java.io.Writer

lock

Constructor Summary

Constructors

Constructor and Description
CapturingWriter(Writer output, CapturingWriter.Config config) Creates a new capturing writer.

Method Summary

Modifier and Type	Method and Description
Writer	append(char c)
Writer	append(CharSequence csq)
Writer	append(CharSequence csq, int start, int end)
String	captured() Returns the contents that have been captured.
void	close()
static CapturingWriter.Config.Builder	config() Creates a builder for capturing writer configurations.
void	done() Marks the capturing as done.
void	flush()
boolean	isClosed() Returns whether or not this writer has been closed.
long	totalChars() Returns the total number of characters that have been written.
void	write(char[] c)
void	write(char[] c, int off, int len)
void	write(int c)
void	write(String str)
void	write(String str, int off, int len)

Methods inherited from class java.lang.Object

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

Constructor Detail

CapturingWriter

public CapturingWriter(Writer output,
                       CapturingWriter.Config config)

Creates a new capturing writer.

Parameters:

output - The writer to capture from.

config - The configuration to use.

Throws:

NullPointerException - If the given writer or config is null.

Method Detail

write

public void write(int c)
           throws IOException

Overrides:

write in class Writer

Throws:

IOException

write

public void write(char[] c)
           throws IOException

Overrides:

write in class Writer

Throws:

IOException

write

public void write(char[] c,
                  int off,
                  int len)
           throws IOException

Specified by:

write in class Writer

Throws:

IOException

write

public void write(String str)
           throws IOException

Overrides:

write in class Writer

Throws:

IOException

write

public void write(String str,
                  int off,
                  int len)
           throws IOException

Overrides:

write in class Writer

Throws:

IOException

append

public Writer append(CharSequence csq)
              throws IOException

Specified by:

append in interface Appendable

Overrides:

append in class Writer

Throws:

IOException

append

public Writer append(CharSequence csq,
                     int start,
                     int end)
              throws IOException

Specified by:

append in interface Appendable

Overrides:

append in class Writer

Throws:

IOException

append

public Writer append(char c)
              throws IOException

Specified by:

append in interface Appendable

Overrides:

append in class Writer

Throws:

IOException

flush

public void flush()
           throws IOException

Specified by:

flush in interface Flushable

Specified by:

flush in class Writer

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in class Writer

Throws:

IOException

done

public void done()

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

captured

public String captured()

Returns the contents that have been captured.

Returns:

A string representing the contents that have been captured.

totalChars

public long totalChars()

Returns the total number of characters that have been written.

Returns:

The total number of characters that have been written.

isClosed

public boolean isClosed()

Returns whether or not this writer has been closed.

Returns:

true if this writer has been closed, or false otherwise.

config

public static CapturingWriter.Config.Builder config()

Creates a builder for capturing writer configurations.

Returns:

The created builder.