org.apache.juneau.internal

Class TeeWriter

java.lang.Object

java.io.Writer

org.apache.juneau.internal.TeeWriter

All Implemented Interfaces:

Closeable, Flushable, Appendable, AutoCloseable

public class TeeWriter
extends Writer

Writer that can send output to multiple writers.

Field Summary

Fields inherited from class java.io.Writer

lock

Constructor Summary

Constructors

Constructor and Description
TeeWriter(Collection<Writer> writers) Constructor.
TeeWriter(Writer... writers) Constructor.

Method Summary

Modifier and Type	Method and Description
TeeWriter	add(String id, Writer w, boolean close) Same as add(Writer, boolean) but associates the writer with an identifier so the writer can be retrieved through getWriter(String).
TeeWriter	add(Writer w, boolean close) Adds a writer to this tee writer.
void	close()
void	flush()
Writer	getWriter(String id) Returns the writer identified through the id parameter passed in through the add(String, Writer, boolean) method.
int	size() Returns the number of inner writers in this tee writer.
void	write(char[] cbuf, int off, int len)

Methods inherited from class java.io.Writer

append, append, append, write, write, write, write

Methods inherited from class java.lang.Object

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

Constructor Detail

TeeWriter

public TeeWriter(Writer... writers)

Constructor.

Parameters:

writers - The list of writers.

TeeWriter

public TeeWriter(Collection<Writer> writers)

Constructor.

Parameters:

writers - The list of writers.

Method Detail

add

public TeeWriter add(Writer w,
                     boolean close)

Adds a writer to this tee writer.

Parameters:

w - The writer to add to this tee writer.

close - If false, then calling close() on this tee writer will not filter to the specified writer.

Returns:

This object (for method chaining).

add

public TeeWriter add(String id,
                     Writer w,
                     boolean close)

Same as add(Writer, boolean) but associates the writer with an identifier so the writer can be retrieved through getWriter(String).

Parameters:

id - The ID to associate the writer with.

w - The writer to add.

close - Close the specified writer afterwards.

Returns:

This object (for method chaining).

size

public int size()

Returns the number of inner writers in this tee writer.

Returns:

The number of writers.

getWriter

public Writer getWriter(String id)

Returns the writer identified through the id parameter passed in through the add(String, Writer, boolean) method.

Parameters:

id - The ID associated with the writer.

Returns:

The writer, or null if no identifier was specified when the writer was added.

write

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

Specified by:

write 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