Module io.github.ascopes.jct

Package io.github.ascopes.jct.diagnostics

Class TeeWriter

java.lang.Object

java.io.Writer

io.github.ascopes.jct.diagnostics.TeeWriter

All Implemented Interfaces:

Closeable, Flushable, Appendable, AutoCloseable

@API(since="0.0.1",
     status=STABLE)
public final class TeeWriter
extends Writer

A writer that wraps an output stream and also writes any content to an in-memory buffer.

This is thread-safe.

Since:

0.0.1

Author:

Ashley Scopes

Constructor Summary

Constructors

Constructor	Description
TeeWriter(Writer writer)	Initialise the writer.

Method Summary

Modifier and Type	Method	Description
void	close()
void	flush()
String	getContent()	Get the content of the internal buffer.
String	toString()	Get the content of the internal buffer.
static TeeWriter	wrapOutputStream(OutputStream outputStream, Charset charset)	Create a tee writer for the given output stream.
void	write(char[] buffer, int offset, int length)

Methods inherited from class java.io.Writer

append, append, append, nullWriter, write, write, write, write

Methods inherited from class java.lang.Object

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

Constructor Details

TeeWriter

public TeeWriter(Writer writer)

Initialise the writer.

Parameters:

writer - the underlying writer to "tee" to.

Method Details

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close 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

getContent

@API(since="0.2.1",
     status=STABLE)
public String getContent()

Get the content of the internal buffer.

Returns:

the content.

Since:

0.2.1

toString

public String toString()

Get the content of the internal buffer.

This calls getContent() internally as of 0.2.1.

Overrides:

toString in class Object

Returns:

the content.

write

public void write(char[] buffer,
 int offset,
 int length)
           throws IOException

Specified by:

write in class Writer

Throws:

IOException

wrapOutputStream

@API(since="0.2.1",
     status=STABLE)
public static TeeWriter wrapOutputStream(OutputStream outputStream,
 Charset charset)

Create a tee writer for the given output stream.

Remember you may need to manually flush the tee writer for all contents to be committed to the output stream.

Parameters:

outputStream - the output stream.

charset - the charset.

Returns:

the Tee Writer.

Since:

0.2.1