com.goldencode.p2j.util

Class InputStreamWrapper

java.lang.Object

java.io.InputStream

com.goldencode.p2j.util.InputStreamWrapper

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public class InputStreamWrapper
extends java.io.InputStream

Provides a Java InputStream which accesses a contained Stream instance. This allows classes that use the standard Java I/O features (in package java.io.*) to transparently use a P2J stream instead. That stream may be on a remote node.

Field Summary

Fields

Modifier and Type	Field and Description
private long	mark The marked position in the stream.
private static int	READ_CHUNK_SIZE The chunk to read at once from the remote stream, via in the read(byte[], int, int) implementation.
private Stream	stream The contained stream that does our real work.

Constructor Summary

Constructors

Constructor and Description
InputStreamWrapper(Stream stream) Construct an instance which wrappers the given stream.

Method Summary

Modifier and Type	Method and Description
int	available() Obtains an estimate of the number of bytes that can be read from this stream without blocking.
void	close() Closes the input stream and releases OS resources associated with it.
Stream	getStream() Get the wrapped FWD stream.
void	mark(int readlimit) Mark the current position in the stream.
boolean	markSupported() Tests if this stream supports the mark mode.
int	read() Reads the next byte of data from the input stream.
int	read(byte[] array, int off, int len) Read a chunk of bytes from the current read position in the stream to the offset calculated by given length or to the EOF, whichever comes first.
void	reset() Reset the stream to the marked position.

Methods inherited from class java.io.InputStream

read, skip

Methods inherited from class java.lang.Object

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

Field Detail

READ_CHUNK_SIZE

private static final int READ_CHUNK_SIZE

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

See Also:

Constant Field Values

stream

private Stream stream

The contained stream that does our real work.

mark

private long mark

The marked position in the stream.

Constructor Detail

InputStreamWrapper

public InputStreamWrapper(Stream stream)

Construct an instance which wrappers the given stream.

Parameters:

stream - The P2J stream to wrap.

Method Detail

getStream

public Stream getStream()

Get the wrapped FWD stream.

Returns:

The stream.

read

public int read()
         throws java.io.IOException

Reads the next byte of data from the input stream. Although the byte is returned as a 32-bit int, the actual value will always be between 0 and 255 inclusive. When the end of the stream has been reached, -1 is returned.

The underlying stream subclass determines the content of the result. Byte oriented streams such as pipes or files will return a byte while streams that generate keystrokes or characters may return a DBCS or Unicode character. Any data that is greater in size than a byte will be truncated!

This method blocks waiting for the data, the end of the stream or some exceptional condition.

Specified by:

read in class java.io.InputStream

Returns:

The next byte of data or -1 when the end of the stream is reached.

Throws:

java.io.IOException

read

public int read(byte[] array,
                int off,
                int len)
         throws java.io.IOException

Read a chunk of bytes from the current read position in the stream to the offset calculated by given length or to the EOF, whichever comes first. The EOF character is not returned.

Overrides:

read in class java.io.InputStream

Parameters:

array - The array in which to save bytes.

off - The offset into the array at which to start saving bytes.

len - The maximum number of bytes to read.

Returns:

The number of bytes read or -1 if EOF has been reached). The number of bytes read will be the smaller of the len parameter or the actual bytes left before the EOF.

Throws:

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

available

public int available()
              throws java.io.IOException

Obtains an estimate of the number of bytes that can be read from this stream without blocking. This number is not reliable in an absolute sense, but it does specify a minimum that can be used.

Overrides:

available in class java.io.InputStream

Returns:

The minimum number of bytes immediately.

Throws:

java.io.IOException

close

public void close()

Closes the input stream and releases OS resources associated with it.

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Overrides:

close in class java.io.InputStream

mark

public void mark(int readlimit)

Mark the current position in the stream.

Overrides:

mark in class java.io.InputStream

Parameters:

readlimit - This argument is not used.

reset

public void reset()
           throws java.io.IOException

Reset the stream to the marked position.

Overrides:

reset in class java.io.InputStream

Throws:

java.io.IOException

markSupported

public boolean markSupported()

Tests if this stream supports the mark mode.

Overrides:

markSupported in class java.io.InputStream

Returns:

Alwaystrue.