org.tanukisoftware.wrapper

Class WrapperProcessInputStream

java.lang.Object

java.io.InputStream

org.tanukisoftware.wrapper.WrapperProcessInputStream

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public class WrapperProcessInputStream
extends java.io.InputStream

The InputStream Class of a WrapperProcess, representing all the data the ChildProcess writes to the Wrapper.

Since:

Wrapper 3.4.0

Author:

Tanuki Software Development Team <support@tanukisoftware.com>

Method Summary

Modifier and Type	Method and Description
int	available() Returns an estimate of the number of bytes that can be read (or skipped over) from this input stream without blocking by the next invocation of a method for this input stream.
void	close() Closes the InputStream
boolean	markSupported() Tests if this input stream supports the mark and reset methods.
int	read() Read a character from the Stream and moves the position in the stream
int	read(byte[] b) Reads some number of bytes from the input stream and stores them into the buffer array b.
int	read(byte[] b, int off, int len) Reads up to len bytes of data from the input stream into an array of bytes.
boolean	ready() Deprecated. As this is a non-standard InputStream method.

Methods inherited from class java.io.InputStream

mark, reset, skip

Methods inherited from class java.lang.Object

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

Method Detail

available

public int available()
              throws java.io.IOException

Returns an estimate of the number of bytes that can be read (or skipped over) from this input stream without blocking by the next invocation of a method for this input stream. The next invocation might be the same thread or another thread. A single read or skip of this many bytes will not block, but may read or skip fewer bytes.

Overrides:

available in class java.io.InputStream

Returns:

An estimate of the number of bytes that can be read (or skipped over) from this input stream without blocking or 0 when it reaches the end of the input stream.

Throws:

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

close

public void close()
           throws java.io.IOException

Closes the InputStream

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Overrides:

close in class java.io.InputStream

Throws:

java.io.IOException - in case of any file errors

WrapperLicenseError - If the function is called other than in the Professional Edition or from a Standalone JVM.

markSupported

public boolean markSupported()

Tests if this input stream supports the mark and reset methods. The markSupported method of InputStream returns false.

Overrides:

markSupported in class java.io.InputStream

Returns:

false.

ready

public boolean ready()

Deprecated. As this is a non-standard InputStream method.

Returns TRUE if the backend connection is open or there is still any output available in buffered input.

Returns:

TRUE if ready, otherwise FALSE.

read

public int read()
         throws java.io.IOException

Read a character from the Stream and moves the position in the stream

Specified by:

read in class java.io.InputStream

Returns:

A single character from the stream, or -1 when the end of stream is reached.

Throws:

java.io.IOException - in case the stream has been already closed or any other file error

WrapperLicenseError - If the function is called other than in the Professional Edition or from a Standalone JVM.

read

public int read(byte[] b)
         throws java.io.IOException

Reads some number of bytes from the input stream and stores them into the buffer array b. The number of bytes actually read is returned as an integer. This method blocks until input data is available, end of file is detected, or an exception is thrown. If the length of b is zero, then no bytes are read and 0 is returned; otherwise, there is an attempt to read at least one byte. If no byte is available because the stream is at the end of the file, the value -1 is returned; otherwise, at least one byte is read and stored into b. The first byte read is stored into element b[0], the next one into b[1], and so on. The number of bytes read is, at most, equal to the length of b. Let k be the number of bytes actually read; these bytes will be stored in elements b[0] through b[k-1], leaving elements b[k] through b[b.length-1] unaffected. The read(b) method for class InputStream has the same effect as: read(b, 0, b.length)

Overrides:

read in class java.io.InputStream

Parameters:

b - The buffer into which the data is read.

Returns:

The total number of bytes read into the buffer, or -1 is there is no more data because the end of the stream has been reached.

Throws:

java.io.IOException - If the first byte cannot be read for any reason other than the end of the file, if the input stream has been closed, or if some other I/O error occurs.

WrapperLicenseError - If the function is called other than in the Professional Edition or from a Standalone JVM.

read

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

Reads up to len bytes of data from the input stream into an array of bytes. An attempt is made to read as many as len bytes, but a smaller number may be read. The number of bytes actually read is returned as an integer. This method blocks until input data is available, end of file is detected, or an exception is thrown. If len is zero, then no bytes are read and 0 is returned; otherwise, there is an attempt to read at least one byte. If no byte is available because the stream is at end of file, the value -1 is returned; otherwise, at least one byte is read and stored into b. The first byte read is stored into element b[off], the next one into b[off+1], and so on. The number of bytes read is, at most, equal to len. Let k be the number of bytes actually read; these bytes will be stored in elements b[off] through b[off+k-1], leaving elements b[off+k] through b[off+len-1] unaffected. In every case, elements b[0] through b[off] and elements b[off+len] through b[b.length-1] are unaffected.

Overrides:

read in class java.io.InputStream

Parameters:

b - The buffer into which the data is read.

off - The start offset in array b from which the data is read.

len - The maximum number of bytes to read.

Returns:

The total number of bytes read into the buffer, or -1 is there is no more data because the end of the stream has been reached.

Throws:

java.io.IOException - If the first byte cannot be read for any reason other than the end of the file, if the input stream has been closed, or if some other I/O error occurs.

WrapperLicenseError - If the function is called other than in the Professional Edition or from a Standalone JVM.