- 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 classFilterWriter
itself provides default methods that pass all requests to the contained stream. Subclasses ofFilterWriter
should override some of these methods and may also provide additional methods and fields.- Since:
- JDK1.1
-
-
Field Summary
Fields Modifier and Type Field and Description protected Writer
out
The underlying character-output stream.-
Fields inherited from class java.io.Writer
lock
-
-
Constructor Summary
Constructors Modifier Constructor and Description protected
FilterWriter(Writer out)
Create a new filtered writer.
-
Method Summary
Methods Modifier and Type Method and Description void
close()
Closes the stream, flushing it first.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.
-
-
-
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 writtenoff
- Offset from which to start reading characterslen
- Number of characters to be written- Throws:
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 writtenoff
- Offset from which to start reading characterslen
- Number of characters to be written- Throws:
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
-
close
public void close() throws IOException
Description copied from class:Writer
Closes the stream, flushing it first. Once the stream has been closed, further write() or flush() invocations will cause an IOException to be thrown. Closing a previously closed stream has no effect.- Specified by:
close
in interfaceCloseable
- Specified by:
close
in interfaceAutoCloseable
- Specified by:
close
in classWriter
- Throws:
IOException
- If an I/O error occurs
-
-
Document created the 11/06/2005, last modified the 04/03/2020
Source of the printed document:https://www.gaudry.be/en/java-api-rf-java/io/filterwriter.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.