java.lang.Object
java.io.Writer
java.io.FilterWriter
- All Implemented Interfaces:
Closeable,Flushable,Appendable,AutoCloseable
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
Fields -
Constructor Summary
Constructors -
Method Summary
-
Field Details
-
out
The underlying character-output stream.
-
-
Constructor Details
-
FilterWriter
Create a new filtered writer.- Parameters:
out- a Writer object to provide the underlying stream.- Throws:
NullPointerException- ifoutisnull
-
-
Method Details
-
write
Writes a single character.- Overrides:
writein classWriter- Parameters:
c- int specifying a character to be written- Throws:
IOException- If an I/O error occurs
-
write
Writes a portion of an array of characters.- Specified by:
writein classWriter- Parameters:
cbuf- Buffer of characters to be writtenoff- Offset from which to start reading characterslen- Number of characters to be written- Throws:
IndexOutOfBoundsException- If the values of theoffandlenparameters cause the corresponding method of the underlyingWriterto throw anIndexOutOfBoundsExceptionIOException- If an I/O error occurs
-
write
Writes a portion of a string.- Overrides:
writein classWriter- Parameters:
str- String to be writtenoff- Offset from which to start reading characterslen- Number of characters to be written- Throws:
IndexOutOfBoundsException- If the values of theoffandlenparameters cause the corresponding method of the underlyingWriterto throw anIndexOutOfBoundsExceptionIOException- If an I/O error occurs
-
flush
Flushes the stream.- Specified by:
flushin interfaceFlushable- Specified by:
flushin classWriter- Throws:
IOException- If an I/O error occurs
-
close
Description copied from class:WriterCloses 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:
closein interfaceAutoCloseable- Specified by:
closein interfaceCloseable- Specified by:
closein classWriter- Throws:
IOException- If an I/O error occurs
-