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

Class MultiPartFormContent

java.lang.Object

net.lenni0451.commons.httpclient.content.HttpContent

net.lenni0451.commons.httpclient.content.impl.MultiPartFormContent

public class MultiPartFormContent
extends HttpContent

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MultiPartFormContent.FormPart

Constructor Summary

Constructors

Constructor	Description
MultiPartFormContent()
MultiPartFormContent(java.lang.String boundary)

Method Summary

Modifier and Type	Method	Description
MultiPartFormContent	addPart(java.lang.String name, HttpContent content)	Add a new part to the form data.
MultiPartFormContent	addPart(java.lang.String name, HttpContent content, java.lang.String fileName)	Add a new part to the form data.
MultiPartFormContent	addPart(MultiPartFormContent.FormPart part)	Add a new part to the form data.
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.

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

MultiPartFormContent

public MultiPartFormContent()

MultiPartFormContent

public MultiPartFormContent(java.lang.String boundary)

Method Detail

addPart

public MultiPartFormContent addPart(java.lang.String name,
                                    HttpContent content)

Add a new part to the form data.

Parameters:

name - The name of the part

content - The content of the part

Returns:

This instance for chaining

See Also:

MultiPartFormContent.FormPart

addPart

public MultiPartFormContent addPart(java.lang.String name,
                                    HttpContent content,
                                    @Nullable
                                    java.lang.String fileName)

Add a new part to the form data.

Parameters:

name - The name of the part

content - The content of the part

fileName - The file name of the part

Returns:

This instance for chaining

addPart

public MultiPartFormContent addPart(MultiPartFormContent.FormPart part)

Add a new part to the form data.

Parameters:

part - The part to add

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