java.io

Class FilterOutputStream

Implemented Interfaces:
AutoCloseable, Closeable, Flushable
Known Direct Subclasses:
BufferedOutputStream, CheckedOutputStream, CipherOutputStream, DataOutputStream, DeflaterOutputStream, DigestOutputStream, PrintStream

public class FilterOutputStream
extends OutputStream

This class is the common superclass of output stream classes that filter the output they write. These classes typically transform the data in some way prior to writing it out to another underlying OutputStream. This class simply overrides all the methods in OutputStream to redirect them to the underlying stream. Subclasses provide actual filtering.

Field Summary

protected OutputStream
out
This is the subordinate OutputStream that this class redirects its method calls to.

Constructor Summary

FilterOutputStream(OutputStream out)
This method initializes an instance of FilterOutputStream to write to the specified subordinate OutputStream.

Method Summary

void
close()
This method closes the underlying OutputStream.
void
flush()
This method attempt to flush all buffered output to be written to the underlying output sink.
void
write(byte[] buf)
This method writes all the bytes in the specified array to the underlying OutputStream.
void
write(byte[] buf, int offset, int len)
This method calls the write(int) method len times for all bytes from the array buf starting at index offset.
void
write(int b)
This method writes a single byte of output to the underlying OutputStream.

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
This is the subordinate OutputStream that this class redirects its method calls to.

Constructor Details

FilterOutputStream

public FilterOutputStream(OutputStream out)
This method initializes an instance of FilterOutputStream to write to the specified subordinate OutputStream.
Parameters:
out - The OutputStream to write to

Method Details

close

public void close()
            throws IOException
This method closes the underlying OutputStream. Any further attempts to write to this stream may throw an exception.
Specified by:
close in interface Closeable
close in interface AutoCloseable
Overrides:
close in interface OutputStream
Throws:
IOException - If an error occurs

flush

public void flush()
            throws IOException
This method attempt to flush all buffered output to be written to the underlying output sink.
Specified by:
flush in interface Flushable
Overrides:
flush in interface OutputStream
Throws:
IOException - If an error occurs

write

public void write(byte[] buf)
            throws IOException
This method writes all the bytes in the specified array to the underlying OutputStream. It does this by calling the three parameter version of this method - write(byte[], int, int) in this class instead of writing to the underlying OutputStream directly. This allows most subclasses to avoid overriding this method.
Overrides:
write in interface OutputStream
Parameters:
buf - The byte array to write bytes from
Throws:
IOException - If an error occurs

write

public void write(byte[] buf,
                  int offset,
                  int len)
            throws IOException
This method calls the write(int) method len times for all bytes from the array buf starting at index offset. Subclasses should overwrite this method to get a more efficient implementation.
Overrides:
write in interface OutputStream
Parameters:
buf - The byte array to write bytes from
offset - The index into the array to start writing bytes from
len - The number of bytes to write
Throws:
IOException - If an error occurs

write

public void write(int b)
            throws IOException
This method writes a single byte of output to the underlying OutputStream.
Overrides:
write in interface OutputStream
Parameters:
b - The byte to write, passed as an int.
Throws:
IOException - If an error occurs

FilterOutputStream.java -- Parent class for output streams that filter Copyright (C) 1998, 1999, 2001, 2003, 2005 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.