java.io

Class FilterOutputStream

Implemented Interfaces:
Closeable, Flushable
Known Direct Subclasses:
Base64.OutputStream, BufferedOutputStream, CheckedOutputStream, DataOutputStream, DeflaterOutputStream, DigestOutputStream, FromNetASCIIOutputStream, PrintStream, ProxyOutputStream, SlowOutputStream, SocketOutputStream, ToNetASCIIOutputStream

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.

Since:
JDK1.0

Field Summary

protected OutputStream
out
The underlying output stream to be filtered.

Constructor Summary

FilterOutputStream(OutputStream out)
Creates an output stream filter built on top of the specified underlying output stream.

Method Summary

void
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(b[] )
Writes b.length bytes to this output stream.
void
write(b[] , int off, int len)
Writes len bytes from the specified byte array starting at offset off to this output stream.
void
write(int b)
Writes the specified byte to this output stream.

Methods inherited from class java.io.OutputStream

close, flush, write, write, write

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

out

protected OutputStream out
The underlying output stream to be filtered.

Constructor Details

FilterOutputStream

public 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.out for later use, or null if this instance is to be created without an underlying stream.
Usages and Demos :

View More Examples of FilterOutputStream(OutputStream out)
   1:         zip = new ZipOutputStream(target);
   2:         filter = new FilterOutputStream(zip){
   3:             public void close() {}
   4:         };
   5:     }

View Full Code Here
   1:             
   2:         return new FilterOutputStream(out) {
   3:             public void close() {
   4:             }
   5:         };

View Full Code Here
   1:         final ByteArrayOutputStream baos = new ByteArrayOutputStream();
   2:         return new FilterOutputStream(baos) {
   3:             public void close() throws IOException {
   4:                 super.close();
   5:                 StringResource.this.setValue(encoding == null

View Full Code Here
   1:           PrintStream out=new PrintStream
   2:             (new FilterOutputStream(sk.getOutputStream())
   3:               {
   4:                 public void write(int _c)
   5:                   throws IOException

View Full Code Here
   1: 
   2:         OutputStream os = new FilterOutputStream(System.out) {
   3:             public void close() throws IOException {
   4:             }
   5:         };

View Full Code Here

Method Details

close

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.

Specified by:
close in interface Closeable
Overrides:
close in interface OutputStream
Throws:
IOException - if an I/O error occurs.
See Also:
flush(), out

flush

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.

Specified by:
flush in interface Flushable
Overrides:
flush in interface OutputStream
Throws:
IOException - if an I/O error occurs.
See Also:
out

write

public void write(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.

Overrides:
write in interface OutputStream
Parameters:
Throws:
IOException - if an I/O error occurs.
See Also:
java.io.FilterOutputStream.write(byte[], int, int)

write

public void write(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.

Overrides:
write in interface OutputStream
Parameters:
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)

write

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.

Overrides:
write in interface OutputStream
Parameters:
b - the byte.
Throws:
IOException - if an I/O error occurs.