com.exalead.papi.helper.stream

Interface ContentStream

All Superinterfaces:

java.io.Serializable

All Known Subinterfaces:

ContentStreamSafe

All Known Implementing Classes:

ByteArrayContentStream, ContentStreamSafeLegacy, FileContentStream

public interface ContentStream
extends java.io.Serializable

Base interface to represent a stream with a known length. This interface is deprecated ; see ContentStreamSafe

Method Summary

Modifier and Type	Method and Description
java.io.InputStream	getStream() Gets the underlying input stream.
long	getStreamLength() Gets the size of the underlying input stream in bytes.

Method Detail

getStream

java.io.InputStream getStream()

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.

Returns:

the underlying input stream

getStreamLength

long getStreamLength()

Gets the size of the underlying input stream in bytes.

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.