Class FilterOutputStream
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
Modifier and TypeFieldDescriptionprotected OutputStream
The underlying output stream to be filtered. -
Constructor Summary
ConstructorDescriptionCreates an output stream filter built on top of the specified underlying output stream. -
Method Summary
Modifier and TypeMethodDescriptionvoid
close()
Closes this output stream and releases any system resources associated with the stream.void
flush()
Flushes this output stream and forces any buffered output bytes to be written out to the stream.void
write
(byte[] b) Writesb.length
bytes to this output stream.void
write
(byte[] b, int off, int len) Writeslen
bytes from the specifiedbyte
array starting at offsetoff
to this output stream.void
write
(int b) Writes the specifiedbyte
to 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.out
for later use, ornull
if this instance is to be created without an underlying stream.
-
-
Method Details
-
write
Writes the specifiedbyte
to this output stream.The
write
method ofFilterOutputStream
calls thewrite
method of its underlying output stream, that is, it performsout.write(b)
.Implements the abstract
write
method ofOutputStream
.- Specified by:
write
in classOutputStream
- Parameters:
b
- thebyte
.- Throws:
IOException
- if an I/O error occurs.
-
write
Writesb.length
bytes to this output stream.- Overrides:
write
in classOutputStream
- Implementation Requirements:
- The
write
method ofFilterOutputStream
calls itswrite
method of three arguments with the argumentsb
,0
, andb.length
. - Implementation Note:
- Note that this method does not call the one-argument
write
method 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
Writeslen
bytes from the specifiedbyte
array starting at offsetoff
to this output stream.- Overrides:
write
in classOutputStream
- Implementation Requirements:
- The
write
method ofFilterOutputStream
calls thewrite
method of one argument on eachbyte
to output. - Implementation Note:
- Note that this method does not call the
write
method of its underlying output stream with the same arguments. Subclasses ofFilterOutputStream
should 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
- Ifoff
is negative,len
is negative, orlen
is 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:
flush
in interfaceFlushable
- Overrides:
flush
in classOutputStream
- Implementation Requirements:
- The
flush
method ofFilterOutputStream
calls theflush
method 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:
close
in interfaceAutoCloseable
- Specified by:
close
in interfaceCloseable
- Overrides:
close
in classOutputStream
- Implementation Requirements:
- When not already closed, the
close
method ofFilterOutputStream
calls itsflush
method, and then calls theclose
method of its underlying output stream. - Throws:
IOException
- if an I/O error occurs.- See Also:
-