ca.randolf.net.cs

Class RiverInputStream

Object

java.io.InputStream

ca.randolf.net.cs.RiverInputStream

All Implemented Interfaces:

java.io.Closeable, AutoCloseable

public class RiverInputStream
extends java.io.InputStream
implements AutoCloseable

The RiverInputStream class provides InputStream-like methods for receiving data.

Method Summary

Modifier and Type	Method and Description
void	close() Close this resource, relinquishing any underlying resources.
int	getBlockCount() Return the number of blocks that the input data is comprised of (the size of each block varies depending on the amount of data recieved at once, so this information may only be useful for fine-tuning).
boolean	isClosed() Returns the closed state of this stream.
int	read() Reads the next byte of data from the input stream.
boolean	readBoolean() Reads a boolean flag from this input stream.
String	readString() Reads the next ASCIIZ String from the input stream.

Methods inherited from class java.io.InputStream

available, mark, markSupported, read, read, reset, skip

Methods inherited from class Object

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

Method Detail

close

public void close()

Close this resource, relinquishing any underlying resources.

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class java.io.InputStream

getBlockCount

public int getBlockCount()

Return the number of blocks that the input data is comprised of (the size of each block varies depending on the amount of data recieved at once, so this information may only be useful for fine-tuning).

isClosed

public boolean isClosed()

Returns the closed state of this stream.

read

public int read()
         throws java.io.IOException

Reads the next byte of data from the input stream. The value byte is returned as an int in the range 0 to 255. If no byte is available because the end of the stream has been reached, the value -1 is returned. This method blocks until input data is available, the end of the stream is detected, or an exception is thrown.

Specified by:

read in class java.io.InputStream

Returns:

The next byte of data, or -1 if the end of the stream is reached

Throws:

java.io.IOException - If an I/O error occurs, such as the Stream has been closed

readBoolean

public boolean readBoolean()
                    throws java.io.IOException

Reads a boolean flag from this input stream.

Returns:

boolean The boolean flag

Throws:

java.io.IOException - If an I/O error occurs, such as the Stream has been closed

readString

public String readString()
                  throws java.io.IOException

Reads the next ASCIIZ String from the input stream. This method blocks until byte 0 is reached, the end of the stream is detected, or an exception is thrown.

Returns:

String (not including termination byte 0)

Throws:

java.io.IOException - If an I/O error occurs, such as the Stream has been closed