com.exalead.papi.helper.stream

Class ByteArrayContentStream

java.lang.Object

com.exalead.papi.helper.stream.ByteArrayContentStream

All Implemented Interfaces:

ContentStream, ContentStreamSafe, java.io.Serializable

public class ByteArrayContentStream
extends java.lang.Object
implements ContentStreamSafe

Basic implementation of the interface ContentStream for data represented by an array of bytes.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ByteArrayContentStream(byte[] data) Constructor specifying the underlying data as an array of bytes.

Method Summary

Modifier and Type	Method and Description
boolean	canRead() Return true if the stream can be read currently.
ContentInputStream	getContentInputStream() Returns the underlying content stream, giving access to the real InputStream and its size.
java.io.InputStream	getStream() Gets the underlying input stream.
long	getStreamLength() Gets the size of the underlying input stream in bytes.

Methods inherited from class java.lang.Object

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

Constructor Detail

ByteArrayContentStream

public ByteArrayContentStream(byte[] data)

Constructor specifying the underlying data as an array of bytes.

Parameters:

data - the underlying data

Method Detail

getStream

public java.io.InputStream getStream()

Description copied from interface: ContentStream

Gets the underlying input stream. The returned stream must be closed by the client after use. Override this method to define you own underlying input stream.

Specified by:

getStream in interface ContentStream

Returns:

the underlying input stream

getStreamLength

public long getStreamLength()

Description copied from interface: ContentStream

Gets the size of the underlying input stream in bytes.

Specified by:

getStreamLength in interface ContentStream

Returns:

the size in bytes of the content contained in the underlying input stream. Return 0 if the content is empty, or if the content can not be accessed. Return -1 if the content can not be accessed.

getContentInputStream

public ContentInputStream getContentInputStream()
                                         throws java.io.IOException

Description copied from interface: ContentStreamSafe

Returns the underlying content stream, giving access to the real InputStream and its size. The returned object holds the real stream at construction time, locking necessary resources. The returned object MUST be closed by the client after use. Implementation note: the stream should be checked for validity before returning, and throw an IOException upon error. This function MUST NOT return a null stream.

Specified by:

getContentInputStream in interface ContentStreamSafe

Returns:

the underlying input stream

Throws:

java.io.IOException - upon I/O error.

canRead

public boolean canRead()

Description copied from interface: ContentStreamSafe

Return true if the stream can be read currently.

Specified by:

canRead in interface ContentStreamSafe

Returns:

true if the stream can be read. Note that a call to getContentInputStream() may fail anyway if the stream state changed in the meantime.