org.codehaus.httpcache4j.payload

Class InputStreamPayload

java.lang.Object

org.codehaus.httpcache4j.payload.InputStreamPayload

All Implemented Interfaces:

Payload

public class InputStreamPayload
extends Object
implements Payload

Represents a payload that is backed by a one-shot inputstream. The stream may be an arbitrary stream type. If you start reading from the stream, the available flag will be set to false, and the next invocation of

Constructor Summary

Constructors

Constructor and Description
InputStreamPayload(InputStream stream, MIMEType mimeType)
InputStreamPayload(InputStream stream, MIMEType mimeType, long length) Constructs an Inputstream payload.

Method Summary

Methods

Modifier and Type	Method and Description
InputStream	getInputStream() Returns the input stream of the payload.
MIMEType	getMimeType() Return the mime-type of the payload.
boolean	isAvailable() Returns true if the payload is available, IE.
long	length() Returns the length of the stream.

Methods inherited from class java.lang.Object

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

Constructor Detail

InputStreamPayload

public InputStreamPayload(InputStream stream,
                  MIMEType mimeType)

InputStreamPayload

public InputStreamPayload(InputStream stream,
                  MIMEType mimeType,
                  long length)

Constructs an Inputstream payload.

Parameters:

stream - the stream to create the payload from; may not be null

mimeType - the mime type of the stream. Defaults to application/octet-stream if not set.

Method Detail

getMimeType

public MIMEType getMimeType()

Description copied from interface: Payload

Return the mime-type of the payload.

Specified by:

getMimeType in interface Payload

Returns:

the mime-type

isAvailable

public boolean isAvailable()

Description copied from interface: Payload

Returns true if the payload is available, IE. If the stream can be read from.

Specified by:

isAvailable in interface Payload

Returns:

true if the payload is available. false if not.

getInputStream

public InputStream getInputStream()

Description copied from interface: Payload

Returns the input stream of the payload. This stream MUST be closed when you are done with it.

Specified by:

getInputStream in interface Payload

Returns:

the inputstream of the payload, may return null if the payload is not available.

length

public long length()

Description copied from interface: Payload

Returns the length of the stream. If the payload is used in a HTTPResponse, this is the value of the Content-Length header. If the payload is used in a request, it can be set, or calculated based on the type.

Specified by:

length in interface Payload

Returns:

-1 if the length cannot be calculated or set. Otherwise the expected length of the stream.