com.exalead.papi.helper.stream

Interface ContentStreamSafe

All Superinterfaces:

ContentStream, java.io.Serializable

All Known Implementing Classes:

ByteArrayContentStream, ContentStreamSafeLegacy

public interface ContentStreamSafe
extends ContentStream

Base interface to represent a stream with a known length. The deprecated interface ContentStream is also included to backward compatibility issues.

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.

Methods inherited from interface com.exalead.papi.helper.stream.ContentStream

getStream, getStreamLength

Method Detail

getContentInputStream

ContentInputStream getContentInputStream()
                                  throws java.io.IOException

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.

Returns:

the underlying input stream

Throws:

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

canRead

boolean canRead()

Return true if the stream can be read currently.

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.