- 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 classFilterWriteritself provides default methods that pass all requests to the contained stream. Subclasses ofFilterWritershould override some of these methods and may also provide additional methods and fields.- Since:
- 1.1
-
-
Constructor Summary
Constructors Modifier Constructor Description protectedFilterWriter(Writer out)Create a new filtered writer.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidflush()Flushes the stream.voidwrite(char[] cbuf, int off, int len)Writes a portion of an array of characters.voidwrite(int c)Writes a single character.voidwrite(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- ifoutisnull
-
-
Method Detail
-
write
public void write(int c) throws IOExceptionWrites a single character.- Overrides:
writein 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 IOExceptionWrites 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
public void write(String str, int off, int len) throws IOException
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
public void flush() throws IOExceptionFlushes the stream.- Specified by:
flushin interfaceFlushable- Specified by:
flushin classWriter- Throws:
IOException- If an I/O error occurs
-
-