Package com.levigo.jadice.server.shared.types

Class BundledStream

java.lang.Object

com.levigo.jadice.server.shared.types.BundledStream

All Implemented Interfaces:

Stream, Closeable, AutoCloseable

public class BundledStream
extends Object
implements Stream

A BundledStream is an abstraction that contains an InputStream and a StreamDescriptor. The descriptors are being used by the Nodes to decide if they can / will handle this stream or not.

Example:
We have a StreamBundle containing two Streams, one representing a TIFF file and one representing a GIF file. If we want to do a kind of "GIF2TIFF" conversion in a certain Node, this worker will only convert the second stream (the GIF file).

Constructor Summary

Constructors

Constructor	Description
BundledStream(InputStream stream, StreamDescriptor type)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	close()	Closes the encapsulated input stream.
StreamDescriptor	getDescriptor()	Get the associated StreamDescriptor.
com.levigo.jadice.document.io.SeekableInputStream	getInputStream()	Get the associated SeekableInputStream.

Methods inherited from class java.lang.Object

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

Constructor Detail

BundledStream

public BundledStream(InputStream stream,
                     StreamDescriptor type)

Constructor.

Parameters:

stream - the InputStream. Must not be null.

type - the associated StreamDescriptor. Must not be null.

Method Detail

getInputStream

public com.levigo.jadice.document.io.SeekableInputStream getInputStream()
                                                                 throws IOException

Description copied from interface: Stream

Get the associated SeekableInputStream.

Specified by:

getInputStream in interface Stream

Returns:

the Stream's content

Throws:

IOException - if an I/O error occurs accessing the InputStream

getDescriptor

public StreamDescriptor getDescriptor()

Description copied from interface: Stream

Get the associated StreamDescriptor.

Specified by:

getDescriptor in interface Stream

Returns:

the Stream's StreamDescriptor

close

public void close()
           throws IOException

Description copied from interface: Stream

Closes the encapsulated input stream.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in interface Stream

Throws:

IOException