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 Summary
FieldsModifier and TypeFieldDescriptionprotected OutputStreamThe underlying output stream to be filtered. -
Constructor Summary
ConstructorsConstructorDescriptionCreates an output stream filter built on top of the specified underlying output stream. -
Method Summary
Modifier 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.OutputStream
nullOutputStream
-
Field Details
-
out
The underlying output stream to be filtered.
-
-
Constructor Details
-
FilterOutputStream
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 fieldthis.outfor later use, ornullif this instance is to be created without an underlying stream.
-
-
Method Details
-
write
Writes 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 classOutputStream- Parameters:
b- thebyte.- Throws:
IOException- if an I/O error occurs.
-
write
Writesb.lengthbytes to this output stream.- Overrides:
writein classOutputStream- 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:
-
write
Writeslenbytes from the specifiedbytearray starting at offsetoffto this output stream.- Overrides:
writein classOutputStream- 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- Ifoffis negative,lenis negative, orlenis greater thanb.length - off- See Also:
-
flush
Flushes this output stream and forces any buffered output bytes to be written out to the stream.- Specified by:
flushin interfaceFlushable- Overrides:
flushin classOutputStream- Implementation Requirements:
- The
flushmethod ofFilterOutputStreamcalls theflushmethod of its underlying output stream. - Throws:
IOException- if an I/O error occurs.- See Also:
-
close
Closes this output stream and releases any system resources associated with the stream.- Specified by:
closein interfaceAutoCloseable- Specified by:
closein interfaceCloseable- Overrides:
closein classOutputStream- 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:
-