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
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.
- Since:
- 1.0
- 
Field SummaryFieldsModifier and TypeFieldDescriptionprotected OutputStreamThe underlying output stream to be filtered.
- 
Constructor SummaryConstructorsConstructorDescriptionCreates an output stream filter built on top of the specified underlying output stream.
- 
Method SummaryModifier and TypeMethodDescriptionvoidclose()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 Details- 
outThe underlying output stream to be filtered.
 
- 
- 
Constructor Details- 
FilterOutputStreamCreates 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 Details- 
writeWrites 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.
 
- 
writeWritesb.lengthbytes to this output stream.- Overrides:
- writein class- OutputStream
- Implementation Requirements:
- The writemethod ofFilterOutputStreamcalls itswritemethod of three arguments with the argumentsb,0, andb.length.
- Implementation Note:
- Note that this method does not call the one-argument
 writemethod of its underlying output stream with the single argumentb.
- Parameters:
- b- the data to be written.
- Throws:
- IOException- if an I/O error occurs.
- See Also:
 
- 
writeWriteslenbytes from the specifiedbytearray starting at offsetoffto this output stream.- Overrides:
- writein class- OutputStream
- Implementation Requirements:
- The writemethod ofFilterOutputStreamcalls thewritemethod of one argument on eachbyteto output.
- Implementation Note:
- 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.
- 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.
- IndexOutOfBoundsException- If- offis negative,- lenis negative, or- lenis greater than- b.length - off
- See Also:
 
- 
flushFlushes this output stream and forces any buffered output bytes to be written out to the stream.- Specified by:
- flushin interface- Flushable
- Overrides:
- flushin class- OutputStream
- Implementation Requirements:
- The flushmethod ofFilterOutputStreamcalls theflushmethod of its underlying output stream.
- Throws:
- IOException- if an I/O error occurs.
- See Also:
 
- 
closeCloses this output stream and releases any system resources associated with the stream.- Specified by:
- closein interface- AutoCloseable
- Specified by:
- closein interface- Closeable
- Overrides:
- closein class- OutputStream
- Implementation Requirements:
- When not already closed, the closemethod ofFilterOutputStreamcalls itsflushmethod, and then calls theclosemethod of its underlying output stream.
- Throws:
- IOException- if an I/O error occurs.
- See Also:
 
 
-