compact1, compact2, compact3
java.io
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 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:
- JDK1.1
-
-
Field Summary
Fields Modifier and Type Field and Description protected WriteroutThe underlying character-output stream.
-
Constructor Summary
Constructors Modifier Constructor and Description protectedFilterWriter(Writer out)Create a new filtered writer.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method and Description voidclose()Closes the stream, flushing it first.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 written -
off- Offset from which to start reading characters -
len- 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:
-
writein classWriter - Parameters:
-
str- String to be written -
off- Offset from which to start reading characters -
len- Number of characters to be written - Throws:
-
IOException- 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
close
public void close() throws IOExceptionDescription 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 interfaceCloseable - Specified by:
-
closein interfaceAutoCloseable - Specified by:
-
closein classWriter - Throws:
-
IOException- If an I/O error occurs
-
Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2022, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
