com.goldencode.p2j.util

Class OutputStreamWrapper

java.lang.Object

java.io.OutputStream

com.goldencode.p2j.util.OutputStreamWrapper

All Implemented Interfaces:

java.io.Closeable, java.io.Flushable, java.lang.AutoCloseable

public class OutputStreamWrapper
extends java.io.OutputStream

Provides an external OutputStream wrapper for a Stream.

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	closable Flag which allow the wrapped stream to be closed.
private Stream	out The wrapped stream.
private static int	WRITE_CHUNK_SIZE The chunk to write at once to the remote stream, via in the write(byte[], int, int) implementation.

Constructor Summary

Constructors

Constructor and Description
OutputStreamWrapper(Stream out) Creates an instance with the associated stream.
OutputStreamWrapper(Stream out, boolean closable) Creates an instance with the associated stream.

Method Summary

Modifier and Type	Method and Description
void	close() Closes the underlying stream and releases OS resources associated with it.
void	flush() Flushes the underlying stream.
void	setClosable() Makes the stream closable back again by resetting the closable property.
void	write(byte[] b) Writes the entire contents of the specified byte array to this output stream.
void	write(byte[] b, int off, int len) Writes len bytes from the specified byte array starting at offset off in this output stream.
void	write(int b) Writes the specified byte to this output stream (only the low order 8 bits are written, the high order 24 bits are ignored).

Methods inherited from class java.lang.Object

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

Field Detail

out

private Stream out

The wrapped stream.

closable

private boolean closable

Flag which allow the wrapped stream to be closed.

WRITE_CHUNK_SIZE

private static final int WRITE_CHUNK_SIZE

The chunk to write at once to the remote stream, via in the write(byte[], int, int) implementation.

See Also:

Constant Field Values

Constructor Detail

OutputStreamWrapper

public OutputStreamWrapper(Stream out)

Creates an instance with the associated stream. The created wrapper is closable.

OutputStreamWrapper

public OutputStreamWrapper(Stream out,
                           boolean closable)

Creates an instance with the associated stream.

Parameters:

closable - Configures whether the wrapper is closable. The attribute can be reset to true using setClosable() method.

Method Detail

write

public void write(int b)
           throws java.io.IOException

Writes the specified byte to this output stream (only the low order 8 bits are written, the high order 24 bits are ignored).

Specified by:

write in class java.io.OutputStream

Parameters:

b - The byte to write.

Throws:

java.io.IOException - if an I/O error occurs. In particular, an IOException may be thrown if the output stream has been closed.

write

public void write(byte[] b)
           throws java.io.IOException,
                  java.lang.NullPointerException

Writes the entire contents of the specified byte array to this output stream.

Overrides:

write in class java.io.OutputStream

Parameters:

b - The byte array to write.

Throws:

java.io.IOException - if an I/O error occurs. In particular, an IOException may be thrown if the output stream has been closed.

java.lang.NullPointerException - if the array is null.

write

public void write(byte[] b,
                  int off,
                  int len)
           throws java.io.IOException,
                  java.lang.NullPointerException,
                  java.lang.IndexOutOfBoundsException

Writes len bytes from the specified byte array starting at offset off in this output stream. Element b[off] is the first byte written and b[off+len-1] is the last byte written.

Overrides:

write in class java.io.OutputStream

Parameters:

b - The array of bytes to write.

off - the start offset in the array.

len - the number of bytes to write.

Throws:

java.io.IOException - if an I/O error occurs. In particular, an IOException may be thrown if the output stream has been closed.

java.lang.NullPointerException - if the array is null.

java.lang.IndexOutOfBoundsException - if the offset or length are negative, or if offset + length is larger than the length of the array.

close

public void close()

Closes the underlying stream and releases OS resources associated with it. This will happen only if the wrapper is closable at this time. If the intent is to trully close the underlying stream, call setClosable() in advance.

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Overrides:

close in class java.io.OutputStream

flush

public void flush()
           throws java.io.IOException

Flushes the underlying stream.

Specified by:

flush in interface java.io.Flushable

Overrides:

flush in class java.io.OutputStream

Throws:

java.io.IOException

setClosable

public void setClosable()

Makes the stream closable back again by resetting the closable property.