- java.lang.Object
- 
- java.io.OutputStream
- 
- java.io.FilterOutputStream
 
 
- 
- All Implemented Interfaces:
- Closeable,- Flushable,- AutoCloseable
 - Direct Known Subclasses:
- BufferedOutputStream,- CheckedOutputStream,- CipherOutputStream,- DataOutputStream,- DeflaterOutputStream,- DigestOutputStream,- InflaterOutputStream,- PrintStream
 
 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 FilterOutputStreamitself simply overrides all methods ofOutputStreamwith versions that pass all requests to the underlying output stream. Subclasses ofFilterOutputStreammay further override some of these methods as well as provide additional methods and fields.- Since:
- 1.0
 
- 
- 
Field SummaryFields Modifier and Type Field Description protected OutputStreamoutThe underlying output stream to be filtered.
 - 
Constructor SummaryConstructors Constructor Description FilterOutputStream(OutputStream out)Creates an output stream filter built on top of the specified underlying output stream.
 - 
Method SummaryAll Methods Instance Methods Concrete Methods Modifier and Type Method Description voidclose()Closes this output stream and releases any system resources associated with the stream.voidflush()Flushes this output stream and forces any buffered output bytes to be written out to the stream.voidwrite(byte[] b)Writesb.lengthbytes to this output stream.voidwrite(byte[] b, int off, int len)Writeslenbytes from the specifiedbytearray starting at offsetoffto this output stream.voidwrite(int b)Writes the specifiedbyteto this output stream.- 
Methods declared in class java.io.OutputStreamnullOutputStream
 
- 
 
- 
- 
- 
Field Detail- 
outprotected OutputStream out The underlying output stream to be filtered.
 
- 
 - 
Constructor Detail- 
FilterOutputStreampublic FilterOutputStream(OutputStream out) Creates an output stream filter built on top of the specified underlying output stream.- Parameters:
- out- the underlying output stream to be assigned to the field- this.outfor later use, or- nullif this instance is to be created without an underlying stream.
 
 
- 
 - 
Method Detail- 
writepublic void write(int b) throws IOExceptionWrites the specifiedbyteto this output stream.The writemethod ofFilterOutputStreamcalls thewritemethod of its underlying output stream, that is, it performsout.write(b).Implements the abstract writemethod ofOutputStream.- Specified by:
- writein class- OutputStream
- Parameters:
- b- the- byte.
- Throws:
- IOException- if an I/O error occurs.
 
 - 
writepublic void write(byte[] b) throws IOExceptionWritesb.lengthbytes to this output stream.The writemethod ofFilterOutputStreamcalls itswritemethod of three arguments with the argumentsb,0, andb.length.Note that this method does not call the one-argument writemethod of its underlying output stream with the single argumentb.- Overrides:
- writein class- OutputStream
- Parameters:
- b- the data to be written.
- Throws:
- IOException- if an I/O error occurs.
- See Also:
- write(byte[], int, int)
 
 - 
writepublic void write(byte[] b, int off, int len) throws IOExceptionWriteslenbytes from the specifiedbytearray starting at offsetoffto this output stream.The writemethod ofFilterOutputStreamcalls thewritemethod of one argument on eachbyteto output.Note that this method does not call the writemethod of its underlying output stream with the same arguments. Subclasses ofFilterOutputStreamshould provide a more efficient implementation of this method.- Overrides:
- writein class- OutputStream
- Parameters:
- b- the data.
- off- the start offset in the data.
- len- the number of bytes to write.
- Throws:
- IOException- if an I/O error occurs.
- See Also:
- write(int)
 
 - 
flushpublic void flush() throws IOExceptionFlushes this output stream and forces any buffered output bytes to be written out to the stream.The flushmethod ofFilterOutputStreamcalls theflushmethod of its underlying output stream.- Specified by:
- flushin interface- Flushable
- Overrides:
- flushin class- OutputStream
- Throws:
- IOException- if an I/O error occurs.
- See Also:
- out
 
 - 
closepublic void close() throws IOExceptionCloses this output stream and releases any system resources associated with the stream.When not already closed, the closemethod ofFilterOutputStreamcalls itsflushmethod, and then calls theclosemethod of its underlying output stream.- Specified by:
- closein interface- AutoCloseable
- Specified by:
- closein interface- Closeable
- Overrides:
- closein class- OutputStream
- Throws:
- IOException- if an I/O error occurs.
- See Also:
- flush(),- out
 
 
- 
 
-