org.ogf.saga.stream

Class StreamInputStream

java.lang.Object

java.io.InputStream

org.ogf.saga.stream.StreamInputStream

All Implemented Interfaces:

Closeable, AutoCloseable, Cloneable, SagaObject, Async

public abstract class StreamInputStream
extends InputStream
implements SagaObject, Async

Since Java programmers are used to streams, the Java language bindings of SAGA provide them. In contrast to everything else in the language bindings, this is an abstract class, not an interface, because it is supposed to be a java.io.InputStream (which is a class, not an interface). Implementations should redefine methods of java.io.InputStream. These streams can be obtained through the Stream.getInputStream() method.

Field Summary

Fields inherited from interface org.ogf.saga.SagaObject

NO_WAIT, WAIT_FOREVER

Constructor Summary

Constructors

Constructor and Description
StreamInputStream()

Method Summary

Methods

Modifier and Type	Method and Description
abstract Task<StreamInputStream,Integer>	available(TaskMode mode) Creates a task that determines how many bytes are available from this stream.
Object	clone() Clone is mentioned here because the inherited Object.clone() cannot hide the public version in SagaObject.clone().
abstract Task<StreamInputStream,Void>	close(TaskMode mode) Creates a task that closes this stream.
abstract Task<StreamInputStream,Void>	mark(TaskMode mode, int readlimit) Creates a task that marks the current position in this stream.
abstract Task<StreamInputStream,Boolean>	markSupported(TaskMode mode) Creates a task that determines if InputStream.mark(int) is supported.
abstract Task<StreamInputStream,Integer>	read(TaskMode mode) Creates a task that reads a byte from this stream.
Task<StreamInputStream,Integer>	read(TaskMode mode, byte[] buf) Creates a task that reads a buffer from this stream.
abstract Task<StreamInputStream,Integer>	read(TaskMode mode, byte[] buf, int off, int len) Creates task that reads (part of) a buffer from this stream.
abstract Task<StreamInputStream,Void>	reset(TaskMode mode) Creates a task that resets the position to the position last marked.
abstract Task<StreamInputStream,Long>	skip(TaskMode mode, long n) Creates a task that skips the specified number of bytes from this stream.

Methods inherited from class java.io.InputStream

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.ogf.saga.SagaObject

getId, getSession

Constructor Detail

StreamInputStream

public StreamInputStream()

Method Detail

clone

public Object clone()
             throws CloneNotSupportedException

Clone is mentioned here because the inherited Object.clone() cannot hide the public version in SagaObject.clone().

Specified by:

clone in interface SagaObject

Overrides:

clone in class Object

Returns:

the clone.

Throws:

CloneNotSupportedException - when the clone method is not supported.

read

public abstract Task<StreamInputStream,Integer> read(TaskMode mode)
                                              throws NotImplementedException

Creates a task that reads a byte from this stream. See InputStream.read().

Parameters:

mode - the task mode.

Throws:

NotImplementedException - is thrown if the implementation does not provide an implementation of this method.

read

public abstract Task<StreamInputStream,Integer> read(TaskMode mode,
                                   byte[] buf,
                                   int off,
                                   int len)
                                              throws NotImplementedException

Creates task that reads (part of) a buffer from this stream. See InputStream.read(byte[], int, int).

Parameters:

mode - the task mode.

Throws:

NotImplementedException - is thrown if the implementation does not provide an implementation of this method.

read

public Task<StreamInputStream,Integer> read(TaskMode mode,
                                   byte[] buf)
                                     throws NotImplementedException

Creates a task that reads a buffer from this stream. See InputStream.read(byte[]).

Parameters:

mode - the task mode.

Throws:

NotImplementedException - is thrown if the implementation does not provide an implementation of this method.

skip

public abstract Task<StreamInputStream,Long> skip(TaskMode mode,
                                long n)
                                           throws NotImplementedException

Creates a task that skips the specified number of bytes from this stream. See InputStream.skip(long).

Parameters:

mode - the task mode.

Throws:

NotImplementedException - is thrown if the implementation does not provide an implementation of this method.

available

public abstract Task<StreamInputStream,Integer> available(TaskMode mode)
                                                   throws NotImplementedException

Creates a task that determines how many bytes are available from this stream. See InputStream.available().

Parameters:

mode - the task mode.

Throws:

NotImplementedException - is thrown if the implementation does not provide an implementation of this method.

close

public abstract Task<StreamInputStream,Void> close(TaskMode mode)
                                            throws NotImplementedException

Creates a task that closes this stream. See InputStream.close().

Parameters:

mode - the task mode.

Throws:

NotImplementedException - is thrown if the implementation does not provide an implementation of this method.

mark

public abstract Task<StreamInputStream,Void> mark(TaskMode mode,
                                int readlimit)
                                           throws NotImplementedException

Creates a task that marks the current position in this stream. See InputStream.mark(int).

Parameters:

mode - the task mode.

Throws:

NotImplementedException - is thrown if the implementation does not provide an implementation of this method.

reset

public abstract Task<StreamInputStream,Void> reset(TaskMode mode)
                                            throws NotImplementedException

Creates a task that resets the position to the position last marked. See InputStream.reset().

Parameters:

mode - the task mode.

Throws:

NotImplementedException - is thrown if the implementation does not provide an implementation of this method.

markSupported

public abstract Task<StreamInputStream,Boolean> markSupported(TaskMode mode)
                                                       throws NotImplementedException

Creates a task that determines if InputStream.mark(int) is supported. See InputStream.markSupported().

Parameters:

mode - the task mode.

Throws:

NotImplementedException - is thrown if the implementation does not provide an implementation of this method.