Closeable
, Flushable
, Appendable
, AutoCloseable
public abstract class FilterWriter extends Writer
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.Modifier and Type | Field | Description |
---|---|---|
protected Writer |
out |
The underlying character-output stream. |
Modifier | Constructor | Description |
---|---|---|
protected |
Create a new filtered writer. |
Modifier and Type | Method | Description |
---|---|---|
void |
close() |
Closes the stream, flushing it first. |
void |
flush() |
Flushes the stream. |
void |
write |
Writes a portion of an array of characters. |
void |
write |
Writes a single character. |
void |
write |
Writes a portion of a string. |
protected Writer out
protected FilterWriter(Writer out)
out
- a Writer object to provide the underlying stream.NullPointerException
- if out
is null
public void write(int c) throws IOException
write
in class Writer
c
- int specifying a character to be writtenIOException
- If an I/O error occurspublic void write(char[] cbuf, int off, int len) throws IOException
write
in class Writer
cbuf
- Buffer of characters to be writtenoff
- Offset from which to start reading characterslen
- Number of characters to be writtenIndexOutOfBoundsException
- If the values of the off
and len
parameters cause the corresponding method of the underlying Writer
to throw an IndexOutOfBoundsException
IOException
- If an I/O error occurspublic void write(String str, int off, int len) throws IOException
write
in class Writer
str
- String to be writtenoff
- Offset from which to start reading characterslen
- Number of characters to be writtenIndexOutOfBoundsException
- If the values of the off
and len
parameters cause the corresponding method of the underlying Writer
to throw an IndexOutOfBoundsException
IOException
- If an I/O error occurspublic void flush() throws IOException
flush
in interface Flushable
flush
in class Writer
IOException
- If an I/O error occurspublic void close() throws IOException
Writer
close
in interface AutoCloseable
close
in interface Closeable
close
in class Writer
IOException
- If an I/O error occurs
© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/io/FilterWriter.html