com.exalead.papi.helper.stream

Class ContentInputStreamContainer

java.lang.Object

com.exalead.papi.helper.stream.ContentInputStreamContainer

All Implemented Interfaces:

ContentInputStream, java.io.Closeable, java.lang.AutoCloseable

public class ContentInputStreamContainer
extends java.lang.Object
implements ContentInputStream

Base container class implementing ContentInputStream

Field Summary

Fields

Modifier and Type	Field and Description
protected long	length
protected java.io.InputStream	stream

Constructor Summary

Constructors

Constructor and Description
ContentInputStreamContainer(java.io.InputStream stream, long length)

Method Summary

Modifier and Type	Method and Description
void	close()
void	finalize()
long	getLength() Gets the size of the underlying input stream in bytes.
java.io.InputStream	getStreamReference() Gets the underlying input stream.

Methods inherited from class java.lang.Object

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

Field Detail

stream

protected final java.io.InputStream stream

length

protected final long length

Constructor Detail

ContentInputStreamContainer

public ContentInputStreamContainer(java.io.InputStream stream,
                                   long length)

Method Detail

getStreamReference

public java.io.InputStream getStreamReference()

Description copied from interface: ContentInputStream

Gets the underlying input stream. The returned stream MUST NOT be closed, but the current object must be closed after use.

Specified by:

getStreamReference in interface ContentInputStream

Returns:

the stream (can not be null).

getLength

public long getLength()

Description copied from interface: ContentInputStream

Gets the size of the underlying input stream in bytes.

Specified by:

getLength in interface ContentInputStream

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.

close

public void close()
           throws java.io.IOException

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.io.IOException

finalize

public void finalize()

Overrides:

finalize in class java.lang.Object