com.levigo.jadice.server.shared.types

Interface StreamBundle

All Superinterfaces:

Iterable<Stream>, Iterator<Stream>

All Known Implementing Classes:

BufferedStreamBundle, com.levigo.jadice.server.shared.types.internal.DefaultStreamBundle

public interface StreamBundle
extends Iterable<Stream>, Iterator<Stream>

Bundles several Streams. The streams may be added asynchronously, therefore access to the streams is purely iterative.

Method Summary

Methods

Modifier and Type	Method and Description
void	abort() Close all bundled streams and shut everything down.
void	addStream(InputStream stream, StreamDescriptor type) Convenience method: add the given InputStream along with its StreamDescriptor by wrapping it in a BundledStream.
void	addStream(Stream s) Add a Stream to this bundle.
OutputStream	addStream(StreamDescriptor type) Convenience method: add a DynamicPipe for the given StreamDescriptor, and return as the OutputStream the write end of the pipe.
void	complete() Signal the completeness of the stream bundle.
boolean	hasNext() Check whether there are more streams to be retrieved.
boolean	isComplete() Return whether this bundle is complete, i.e.
Iterator<Stream>	iterator()
Stream	next() Retrieve the next stream This method may block until either a new stream is available, or the completeness of the bundle has been signaled.
void	remove() Not supported! Throws a UnsupportedOperationException.

Method Detail

addStream

void addStream(InputStream stream,
             StreamDescriptor type)
               throws IOException

Convenience method: add the given InputStream along with its StreamDescriptor by wrapping it in a BundledStream.

Parameters:

stream - The InputStream to add

type - the associated StreamDescriptor

Throws:

IOException - might be thrown if an error occurs when the given InputStream is wrapped to a SeekableInputStream

addStream

OutputStream addStream(StreamDescriptor type)
                       throws IOException

Convenience method: add a DynamicPipe for the given StreamDescriptor, and return as the OutputStream the write end of the pipe.

Parameters:

type -

Returns:

output stream

Throws:

IOException

addStream

void addStream(Stream s)

Add a Stream to this bundle.

Parameters:

s -

Throws:

IOException

iterator

Iterator<Stream> iterator()

Specified by:

iterator in interface Iterable<Stream>

hasNext

boolean hasNext()

Check whether there are more streams to be retrieved. This method may block until either a new stream is available, or the completeness of the bundle has been signaled.

Specified by:

hasNext in interface Iterator<Stream>

See Also:

Iterator.hasNext()

next

Stream next()

Retrieve the next stream This method may block until either a new stream is available, or the completeness of the bundle has been signaled.

Specified by:

next in interface Iterator<Stream>

Throws:

IndexOutOfBoundsException - if there are no more streams.

See Also:

Iterator.next()

remove

void remove()

Not supported! Throws a UnsupportedOperationException.

Specified by:

remove in interface Iterator<Stream>

See Also:

Iterator.remove()

isComplete

boolean isComplete()

Return whether this bundle is complete, i.e. all streams have been received. This method differs from hasNext() by never blocking.

Returns:

true iff this bundle is complete

complete

void complete()

Signal the completeness of the stream bundle.

abort

void abort()

Close all bundled streams and shut everything down. Beware: closing a bundle is rather disrupting. For a normal termination with no more data available use complete().