org.codehaus.httpcache4j.payload

Class StringPayload

java.lang.Object

org.codehaus.httpcache4j.payload.StringPayload

All Implemented Interfaces:

Serializable, Payload

public final class StringPayload
extends Object
implements Payload, Serializable

Version:

$Revision: $

Author:

Erlend Hamnaberg

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
StringPayload(String value, MIMEType mimeType)
StringPayload(String value, MIMEType mimeType, Charset charset)

Method Summary

Modifier and Type	Method and Description
static StringPayload	fromInputStream(InputStream is, MIMEType mime)
static StringPayload	fromInputStream(InputStream is, MIMEType mime, Charset charset)
Charset	getCharset()
InputStream	getInputStream() Returns the input stream of the payload.
MIMEType	getMimeType() Return the mime-type of the payload.
String	getValue()
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

Methods inherited from interface org.codehaus.httpcache4j.payload.Payload

transform

Constructor Detail

StringPayload

public StringPayload(String value,
                     MIMEType mimeType)

StringPayload

public StringPayload(String value,
                     MIMEType mimeType,
                     Charset charset)

Method Detail

fromInputStream

public static StringPayload fromInputStream(InputStream is,
                                            MIMEType mime,
                                            Charset charset)
                                     throws IOException

Throws:

IOException

fromInputStream

public static StringPayload fromInputStream(InputStream is,
                                            MIMEType mime)
                                     throws IOException

Throws:

IOException

getValue

public String getValue()

getCharset

public Charset getCharset()

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

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.

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.