jsimple.io

Class JSimpleInputStreamOnJavaStream

java.lang.Object

jsimple.lang.AutoCloseable

jsimple.io.InputStream

jsimple.io.JSimpleInputStreamOnJavaStream

All Implemented Interfaces:

java.lang.AutoCloseable

public class JSimpleInputStreamOnJavaStream
extends InputStream

Since:

10/7/12 12:30 AM

Constructor Summary

Constructors

Constructor and Description
JSimpleInputStreamOnJavaStream(java.io.InputStream javaInputStream)
JSimpleInputStreamOnJavaStream(java.io.InputStream javaInputStream, boolean ignoreClose) Create a JSimple stream that wraps the specified Java InputStream.

Method Summary

Modifier and Type	Method and Description
void	close() Closes this stream.
int	read() Reads a single byte from this stream and returns it as an integer in the range from 0 to 255.
int	read(byte[] buffer) Reads bytes from this stream and stores them in the byte array b.
int	read(byte[] buffer, int offset, int length) Reads at most length bytes from this stream and stores them in the byte array b starting at offset.

Methods inherited from class jsimple.io.InputStream

copyTo, copyToByteArray, finalize, readFully, readFully

Methods inherited from class java.lang.Object

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

Constructor Detail

JSimpleInputStreamOnJavaStream

public JSimpleInputStreamOnJavaStream(java.io.InputStream javaInputStream)

JSimpleInputStreamOnJavaStream

public JSimpleInputStreamOnJavaStream(java.io.InputStream javaInputStream,
                                      boolean ignoreClose)

Create a JSimple stream that wraps the specified Java InputStream. If ignoreClose is true then calls to close() don't actually close the underlying stream--they don't do anything.

Parameters:

javaInputStream - Java InputStream

ignoreClose - whether or not to close the underlying stream when this stream is closed

Method Detail

read

public int read()

Description copied from class: InputStream

Reads a single byte from this stream and returns it as an integer in the range from 0 to 255. Returns -1 if the end of the stream has been reached. Blocks until one byte has been read, the end of the source stream is detected or an exception is thrown.

Specified by:

read in class InputStream

Returns:

the byte read or -1 if the end of stream has been reached

read

public int read(byte[] buffer)

Description copied from class: InputStream

Reads bytes from this stream and stores them in the byte array b.

Overrides:

read in class InputStream

Parameters:

buffer - the byte array in which to store the bytes read

Returns:

the number of bytes actually read or -1 if the end of the stream has been reached

read

public int read(byte[] buffer,
                int offset,
                int length)

Description copied from class: InputStream

Reads at most length bytes from this stream and stores them in the byte array b starting at offset.

Specified by:

read in class InputStream

Parameters:

buffer - the byte array in which to store the bytes read

offset - the initial position in buffer to store the bytes read from this stream

length - the maximum number of bytes to store in b

Returns:

the number of bytes actually read or -1 if the end of the stream has been reached

close

public void close()

Description copied from class: InputStream

Closes this stream. If the stream is already closed, then this method should do nothing. Concrete implementations of this class should free any resources during close.

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in class InputStream