ca.randelshofer
Class ImageOutputStreamAdapter

java.lang.Object
  java.io.OutputStream
      ca.randelshofer.ImageOutputStreamAdapter

All Implemented Interfaces:

java.io.Closeable, java.io.Flushable

public class ImageOutputStreamAdapter
extends java.io.OutputStream

Adapts an ImageOutputStream for classes requiring an OutputStream.

Version:

1.1 2011-01-07 Fixes performance.
1.0 2010-12-26 Created.

Author:

Werner Randelshofer

Field Summary

protected javax.imageio.stream.ImageOutputStream

out The underlying output stream to be filtered.

Constructor Summary

ImageOutputStreamAdapter(javax.imageio.stream.ImageOutputStream 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(byte[] b) Writes b.length bytes to this output stream.
void	write(byte[] 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.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

out

protected javax.imageio.stream.ImageOutputStream out

The underlying output stream to be filtered.

Constructor Detail

ImageOutputStreamAdapter

public ImageOutputStreamAdapter(javax.imageio.stream.ImageOutputStream 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.

Method Detail

write

public void write(int b)
           throws java.io.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.

Specified by:

write in class java.io.OutputStream

Parameters:

b - the byte.

Throws:

java.io.IOException - if an I/O error occurs.

write

public void write(byte[] b)
           throws java.io.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 class java.io.OutputStream

Parameters:

b - the data to be written.

Throws:

java.io.IOException - if an I/O error occurs.

See Also:

FilterOutputStream.write(byte[], int, int)

write

public void write(byte[] b,
                  int off,
                  int len)
           throws java.io.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 class java.io.OutputStream

Parameters:

b - the data.

off - the start offset in the data.

len - the number of bytes to write.

Throws:

java.io.IOException - if an I/O error occurs.

See Also:

FilterOutputStream.write(int)

flush

public void flush()
           throws java.io.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 java.io.Flushable

Overrides:

flush in class java.io.OutputStream

Throws:

java.io.IOException - if an I/O error occurs.

See Also:

FilterOutputStream.out

close

public void close()
           throws java.io.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 java.io.Closeable

Overrides:

close in class java.io.OutputStream

Throws:

java.io.IOException - if an I/O error occurs.

See Also:

FilterOutputStream.flush(), FilterOutputStream.out