org.apache.commons.io.output

Class FilterCollectionWriter

java.lang.Object

java.io.Writer

org.apache.commons.io.output.FilterCollectionWriter

All Implemented Interfaces:

java.io.Closeable, java.io.Flushable, java.lang.Appendable, java.lang.AutoCloseable

Direct Known Subclasses:

ProxyCollectionWriter

public class FilterCollectionWriter
extends java.io.Writer

Abstract class for writing filtered character streams to a Collection of writers. This is in contrast to FilterWriter which is backed by a single Writer.

This abstract class provides default methods that pass all requests to the contained writers. Subclasses should likely override some of these methods.

The class Writer defines method signatures with throws IOException, which in this class are actually IOExceptionList containing a list of IOIndexedException.

Since:

2.7

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Collection<java.io.Writer>	EMPTY_WRITERS Empty and immutable collection of writers.
protected java.util.Collection<java.io.Writer>	writers The underlying writers.

Fields inherited from class java.io.Writer

lock

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FilterCollectionWriter(java.util.Collection<java.io.Writer> writers) Constructs a new filtered collection writer.
protected	FilterCollectionWriter(java.io.Writer... writers) Constructs a new filtered collection writer.

Method Summary

Modifier and Type	Method and Description
java.io.Writer	append(char c)
java.io.Writer	append(java.lang.CharSequence csq)
java.io.Writer	append(java.lang.CharSequence csq, int start, int end)
void	close()
void	flush() Flushes the stream.
private FilterCollectionWriter	forAllWriters(IOConsumer<java.io.Writer> action)
void	write(char[] cbuf)
void	write(char[] cbuf, int off, int len) Writes a portion of an array of characters.
void	write(int c) Writes a single character.
void	write(java.lang.String str)
void	write(java.lang.String str, int off, int len) Writes a portion of a string.
private java.util.stream.Stream<java.io.Writer>	writers()

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY_WRITERS

protected final java.util.Collection<java.io.Writer> EMPTY_WRITERS

Empty and immutable collection of writers.

writers

protected final java.util.Collection<java.io.Writer> writers

The underlying writers.

Constructor Detail

FilterCollectionWriter

protected FilterCollectionWriter(java.util.Collection<java.io.Writer> writers)

Constructs a new filtered collection writer.

Parameters:

writers - Writers to provide the underlying targets.

FilterCollectionWriter

protected FilterCollectionWriter(java.io.Writer... writers)

Constructs a new filtered collection writer.

Parameters:

writers - Writers to provide the underlying targets.

Method Detail

append

public java.io.Writer append(char c)
                      throws java.io.IOException

Specified by:

append in interface java.lang.Appendable

Overrides:

append in class java.io.Writer

Throws:

java.io.IOException

append

public java.io.Writer append(java.lang.CharSequence csq)
                      throws java.io.IOException

Specified by:

append in interface java.lang.Appendable

Overrides:

append in class java.io.Writer

Throws:

java.io.IOException

append

public java.io.Writer append(java.lang.CharSequence csq,
                             int start,
                             int end)
                      throws java.io.IOException

Specified by:

append in interface java.lang.Appendable

Overrides:

append in class java.io.Writer

Throws:

java.io.IOException

close

public void close()
           throws java.io.IOException

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in class java.io.Writer

Throws:

java.io.IOException

flush

public void flush()
           throws java.io.IOException

Flushes the stream.

Specified by:

flush in interface java.io.Flushable

Specified by:

flush in class java.io.Writer

Throws:

java.io.IOException - If an I/O error occurs

forAllWriters

private FilterCollectionWriter forAllWriters(IOConsumer<java.io.Writer> action)
                                      throws IOExceptionList

Throws:

IOExceptionList

write

public void write(char[] cbuf)
           throws java.io.IOException

Overrides:

write in class java.io.Writer

Throws:

java.io.IOException

write

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

Writes a portion of an array of characters.

Specified by:

write in class java.io.Writer

Parameters:

cbuf - Buffer of characters to be written

off - Offset from which to start reading characters

len - Number of characters to be written

Throws:

java.io.IOException - If an I/O error occurs

write

public void write(int c)
           throws java.io.IOException

Writes a single character.

Overrides:

write in class java.io.Writer

Throws:

java.io.IOException - If an I/O error occurs

write

public void write(java.lang.String str)
           throws java.io.IOException

Overrides:

write in class java.io.Writer

Throws:

java.io.IOException

write

public void write(java.lang.String str,
                  int off,
                  int len)
           throws java.io.IOException

Writes a portion of a string.

Overrides:

write in class java.io.Writer

Parameters:

str - String to be written

off - Offset from which to start reading characters

len - Number of characters to be written

Throws:

java.io.IOException - If an I/O error occurs

writers

private java.util.stream.Stream<java.io.Writer> writers()