Package 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 aCollection
of writers. This is in contrast toFilterWriter
which is backed by a singleWriter
.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 withthrows
IOException
, which in this class are actuallyIOExceptionList
containing a list ofIOIndexedException
.- Since:
- 2.7
-
-
Field Summary
Fields Modifier and Type Field 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.
-
Constructor Summary
Constructors Modifier Constructor Description protected
FilterCollectionWriter(java.io.Writer... writers)
Creates a new filtered collection writer.protected
FilterCollectionWriter(java.util.Collection<java.io.Writer> writers)
Creates a new filtered collection writer.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method 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.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.
-
-
-
Constructor Detail
-
FilterCollectionWriter
protected FilterCollectionWriter(java.util.Collection<java.io.Writer> writers)
Creates a new filtered collection writer.- Parameters:
writers
- Writers to provide the underlying targets.
-
FilterCollectionWriter
protected FilterCollectionWriter(java.io.Writer... writers)
Creates 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 interfacejava.lang.Appendable
- Overrides:
append
in classjava.io.Writer
- Throws:
java.io.IOException
-
append
public java.io.Writer append(java.lang.CharSequence csq) throws java.io.IOException
- Specified by:
append
in interfacejava.lang.Appendable
- Overrides:
append
in classjava.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 interfacejava.lang.Appendable
- Overrides:
append
in classjava.io.Writer
- Throws:
java.io.IOException
-
close
public void close() throws java.io.IOException
- Specified by:
close
in interfacejava.lang.AutoCloseable
- Specified by:
close
in interfacejava.io.Closeable
- Specified by:
close
in classjava.io.Writer
- Throws:
java.io.IOException
-
flush
public void flush() throws java.io.IOException
Flushes the stream.- Specified by:
flush
in interfacejava.io.Flushable
- Specified by:
flush
in classjava.io.Writer
- Throws:
java.io.IOException
- If an I/O error occurs
-
write
public void write(char[] cbuf) throws java.io.IOException
- Overrides:
write
in classjava.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 classjava.io.Writer
- Parameters:
cbuf
- Buffer of characters to be writtenoff
- Offset from which to start reading characterslen
- 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 classjava.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 classjava.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 classjava.io.Writer
- Parameters:
str
- String to be writtenoff
- Offset from which to start reading characterslen
- Number of characters to be written- Throws:
java.io.IOException
- If an I/O error occurs
-
-