Class FilterWriter
- java.lang.Object
-
- java.io.Writer
-
- java.io.FilterWriter
- All Implemented Interfaces:
-
Closeable
,Flushable
,Appendable
,AutoCloseable
public abstract class FilterWriter extends Writer
Abstract class for writing filtered character streams. The abstract class FilterWriter
itself provides default methods that pass all requests to the contained stream. Subclasses of FilterWriter
should override some of these methods and may also provide additional methods and fields.
- Since:
- 1.1
Field Summary
Modifier and Type | Field | Description |
---|---|---|
protected Writer | out | The underlying character-output stream. |
Fields declared in class java.io.Writer
lock
Constructor Summary
Modifier | Constructor | Description |
---|---|---|
protected | FilterWriter(Writer out) | Create a new filtered writer. |
Method Summary
Modifier and Type | Method | Description |
---|---|---|
void | flush() | Flushes the stream. |
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(String str,
int off,
int len) | Writes a portion of a string. |
Methods declared in class java.io.Writer
append, append, append, close, nullWriter, write, write
Methods declared in class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Field Detail
out
protected Writer out
The underlying character-output stream.
Constructor Detail
FilterWriter
protected FilterWriter(Writer out)
Create a new filtered writer.
- Parameters:
-
out
- a Writer object to provide the underlying stream. - Throws:
-
NullPointerException
- ifout
isnull
Method Detail
write
public void write(int c) throws IOException
Writes a single character.
- Overrides:
-
write
in classWriter
- Parameters:
-
c
- int specifying a character to be written - Throws:
-
IOException
- If an I/O error occurs
write
public void write(char[] cbuf, int off, int len) throws IOException
Writes a portion of an array of characters.
- Specified by:
-
write
in classWriter
- Parameters:
-
cbuf
- Buffer of characters to be written -
off
- Offset from which to start reading characters -
len
- Number of characters to be written - Throws:
-
IndexOutOfBoundsException
- If the values of theoff
andlen
parameters cause the corresponding method of the underlyingWriter
to throw anIndexOutOfBoundsException
-
IOException
- If an I/O error occurs
write
public void write(String str, int off, int len) throws IOException
Writes a portion of a string.
- Overrides:
-
write
in classWriter
- Parameters:
-
str
- String to be written -
off
- Offset from which to start reading characters -
len
- Number of characters to be written - Throws:
-
IndexOutOfBoundsException
- If the values of theoff
andlen
parameters cause the corresponding method of the underlyingWriter
to throw anIndexOutOfBoundsException
-
IOException
- If an I/O error occurs
flush
public void flush() throws IOException
Flushes the stream.
- Specified by:
-
flush
in interfaceFlushable
- Specified by:
-
flush
in classWriter
- Throws:
-
IOException
- If an I/O error occurs