Build 1.0_r1(from source)

java.io
Class FilterOutputStream

java.lang.Object
  extended by java.io.OutputStream
      extended by java.io.FilterOutputStream
All Implemented Interfaces:
Closeable, Flushable
Direct Known Subclasses:
BufferedOutputStream, CheckedOutputStream, CipherOutputStream, DataOutputStream, DeflaterOutputStream, DigestOutputStream, PrintStream

public class FilterOutputStream
extends OutputStream

FilteredOutputStream is a class which takes an output stream and filters the output in some way. The filtered view may be a buffered output or one which compresses data before actually writing the bytes. FilterOutputStreams are meant for byte streams.

See Also:
FilterInputStream

Field Summary
protected  OutputStream out
          The target OutputStream for this filter.
 
Constructor Summary
FilterOutputStream(OutputStream out)
          Constructs a new FilterOutputStream on the OutputStream out.
 
Method Summary
 void close()
          Close this FilterOutputStream.
 void flush()
          Flush this FilterOutputStream to ensure all pending data is sent out to the target OutputStream.
 void write(byte[] buffer)
          Writes the entire contents of the byte array buffer to this FilterOutputStream.
 void write(byte[] buffer, int offset, int count)
          Writes count bytes from the byte array buffer starting at offset to this FilterOutputStream.
 void write(int oneByte)
          Writes the specified byte oneByte to this FilterOutputStream.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

out

protected OutputStream out
The target OutputStream for this filter.

Constructor Detail

FilterOutputStream

public FilterOutputStream(OutputStream out)
Constructs a new FilterOutputStream on the OutputStream out. All writes are now filtered through this stream.

Parameters:
out - the target OutputStream to filter writes on.
Method Detail

close

public void close()
           throws IOException
Close this FilterOutputStream. This implementation closes the target stream.

Specified by:
close in interface Closeable
Overrides:
close in class OutputStream
Throws:
IOException - If an error occurs attempting to close this stream.

flush

public void flush()
           throws IOException
Flush this FilterOutputStream to ensure all pending data is sent out to the target OutputStream. This implementation flushes the target OutputStream.

Specified by:
flush in interface Flushable
Overrides:
flush in class OutputStream
Throws:
IOException - If an error occurs attempting to flush this FilterOutputStream.

write

public void write(byte[] buffer)
           throws IOException
Writes the entire contents of the byte array buffer to this FilterOutputStream. This implementation writes the buffer to the target stream.

Overrides:
write in class OutputStream
Parameters:
buffer - the buffer to be written
Throws:
IOException - If an error occurs attempting to write to this FilterOutputStream.

write

public void write(byte[] buffer,
                  int offset,
                  int count)
           throws IOException
Writes count bytes from the byte array buffer starting at offset to this FilterOutputStream. This implementation writes the buffer to the target OutputStream.

Overrides:
write in class OutputStream
Parameters:
buffer - the buffer to be written
offset - offset in buffer to get bytes
count - number of bytes in buffer to write
Throws:
IOException - If an error occurs attempting to write to this FilterOutputStream.
IndexOutOfBoundsException - If offset or count are outside of bounds.

write

public void write(int oneByte)
           throws IOException
Writes the specified byte oneByte to this FilterOutputStream. Only the low order byte of oneByte is written. This implementation writes the byte to the target OutputStream.

Specified by:
write in class OutputStream
Parameters:
oneByte - the byte to be written
Throws:
IOException - If an error occurs attempting to write to this FilterOutputStream.

Build 1.0_r1(from source)

Please submit a feedback, bug or feature