org.codehaus.httpcache4j.payload

Class FormDataPayload

java.lang.Object

org.codehaus.httpcache4j.payload.FormDataPayload

All Implemented Interfaces:

Payload

public class FormDataPayload
extends Object
implements Payload

Version:

$Revision: $

Author:

Erlend Hamnaberg

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FormDataPayload.FormParameter Represents a Form Url-encoded data parameter.

Constructor Summary

Constructors

Constructor and Description
FormDataPayload(Iterable<FormDataPayload.FormParameter> parameters)
FormDataPayload(Map<String,List<String>> parameters)

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.
String	getValue()
String	getValues() Deprecated.
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

FormDataPayload

public FormDataPayload(Map<String,List<String>> parameters)

FormDataPayload

public FormDataPayload(Iterable<FormDataPayload.FormParameter> parameters)

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

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.

getValues

@Deprecated
public String getValues()

Deprecated.

getValue

public String getValue()

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.

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.