public class FilterOutputStream extends OutputStream
This class is the superclass of all classes that filter output streams. These streams sit on top of an already existing output stream (the underlying output stream) which it uses as its basic sink of data, but possibly transforming the data along the way or providing additional functionality.
The class FilterOutputStream
itself simply overrides all methods of OutputStream
with versions that pass all requests to the underlying output stream. Subclasses of FilterOutputStream
may further override some of these methods as well as provide additional methods and fields.
protected OutputStream out
The underlying output stream to be filtered.
public FilterOutputStream(OutputStream out)
Creates an output stream filter built on top of the specified underlying output stream.
out
- the underlying output stream to be assigned to the field this.out
for later use, or null
if this instance is to be created without an underlying stream.public void write(int b) throws IOException
Writes the specified byte
to this output stream.
The write
method of FilterOutputStream
calls the write
method of its underlying output stream, that is, it performs out.write(b)
.
Implements the abstract write
method of OutputStream
.
write
in class OutputStream
b
- the byte
.IOException
- if an I/O error occurs.public void write(byte[] b) throws IOException
Writes b.length
bytes to this output stream.
The write
method of FilterOutputStream
calls its write
method of three arguments with the arguments b
, 0
, and b.length
.
Note that this method does not call the one-argument write
method of its underlying stream with the single argument b
.
write
in class OutputStream
b
- the data to be written.IOException
- if an I/O error occurs.write(byte[], int, int)
public void write(byte[] b, int off, int len) throws IOException
Writes len
bytes from the specified byte
array starting at offset off
to this output stream.
The write
method of FilterOutputStream
calls the write
method of one argument on each byte
to output.
Note that this method does not call the write
method of its underlying input stream with the same arguments. Subclasses of FilterOutputStream
should provide a more efficient implementation of this method.
write
in class OutputStream
b
- the data.off
- the start offset in the data.len
- the number of bytes to write.IOException
- if an I/O error occurs.write(int)
public void flush() throws IOException
Flushes this output stream and forces any buffered output bytes to be written out to the stream.
The flush
method of FilterOutputStream
calls the flush
method of its underlying output stream.
flush
in interface Flushable
flush
in class OutputStream
IOException
- if an I/O error occurs.out
public void close() throws IOException
Closes this output stream and releases any system resources associated with the stream.
The close
method of FilterOutputStream
calls its flush
method, and then calls the close
method of its underlying output stream.
close
in interface Closeable
close
in interface AutoCloseable
close
in class OutputStream
IOException
- if an I/O error occurs.flush()
, out
© 1993–2017, 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.