Package net.lenni0451.commons.httpclient.content.impl

Class URLEncodedFormContent

java.lang.Object

net.lenni0451.commons.httpclient.content.HttpContent

net.lenni0451.commons.httpclient.content.impl.URLEncodedFormContent

public class URLEncodedFormContent
extends HttpContent

Constructor Summary

Constructors

Constructor	Description
URLEncodedFormContent()
URLEncodedFormContent(java.nio.charset.Charset charset)
URLEncodedFormContent(java.util.Map<java.lang.String,java.lang.String> entries)
URLEncodedFormContent(java.util.Map<java.lang.String,java.lang.String> entries, java.nio.charset.Charset charset)

Method Summary

Modifier and Type	Method	Description
boolean	canBeStreamedMultipleTimes()	Get if the content can be streamed multiple times. The return value is allowed to change between multiple calls depending on the implementation.
protected java.io.InputStream	compute()	Compute the content and return it as an input stream. This method can be called multiple times if HttpContent.canBeStreamedMultipleTimes() returns true.
int	getLength()	Get the content length in bytes. If the content length is unknown, return -1. Streaming the content may require valid content length depending on the implementation.
URLEncodedFormContent	put(java.lang.String key, java.lang.String value)	Add a new entry to the form.

Methods inherited from class net.lenni0451.commons.httpclient.content.HttpContent

bytes, bytes, clearCache, file, form, form, getAsBytes, getAsStream, getAsString, getAsString, getBufferSize, getContentLength, getContentType, getType, inputStream, modify, multiPartForm, setBufferSize, string, string, transferTo

Methods inherited from class java.lang.Object

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

Constructor Detail

URLEncodedFormContent

public URLEncodedFormContent()

URLEncodedFormContent

public URLEncodedFormContent(java.util.Map<java.lang.String,java.lang.String> entries)

URLEncodedFormContent

public URLEncodedFormContent(java.nio.charset.Charset charset)

URLEncodedFormContent

public URLEncodedFormContent(java.util.Map<java.lang.String,java.lang.String> entries,
                             java.nio.charset.Charset charset)

Method Detail

put

public URLEncodedFormContent put(java.lang.String key,
                                 java.lang.String value)

Add a new entry to the form.

Parameters:

key - The key

value - The value

Returns:

This instance for chaining

canBeStreamedMultipleTimes

public boolean canBeStreamedMultipleTimes()

Description copied from class: HttpContent

Get if the content can be streamed multiple times.
The return value is allowed to change between multiple calls depending on the implementation.

Specified by:

canBeStreamedMultipleTimes in class HttpContent

Returns:

If the content can be streamed multiple times

getLength

public int getLength()

Description copied from class: HttpContent

Get the content length in bytes.
If the content length is unknown, return -1.
Streaming the content may require valid content length depending on the implementation.

Specified by:

getLength in class HttpContent

Returns:

The content length

compute

@Nonnull
protected java.io.InputStream compute()
                               throws java.io.IOException

Description copied from class: HttpContent

Compute the content and return it as an input stream.
This method can be called multiple times if HttpContent.canBeStreamedMultipleTimes() returns true.

Specified by:

compute in class HttpContent

Returns:

The content

Throws:

java.io.IOException - If an I/O error occurs