com.atlassian.httpclient.api

Interface FormBuilder

All Superinterfaces:

Entity.Builder

public interface FormBuilder
extends Entity.Builder

Builds url-encoded form entities for use as HTTP request message bodies. URL encoding of parameter names and values is handled by FormBuilder implementations.

Method Summary

Methods

Modifier and Type	Method and Description
FormBuilder	addParam(java.lang.String name) Adds a value-less parameter.
FormBuilder	addParam(java.lang.String name, java.lang.String value) Adds a parameter and its value.
B	build()
FormBuilder	setParam(java.lang.String name, java.lang.Iterable<java.lang.String> values) Sets multiple values for the named parameter, resetting any existing values in the process.

Method Detail

addParam

FormBuilder addParam(java.lang.String name)

Adds a value-less parameter.

Parameters:

name - The name of the parameter

addParam

FormBuilder addParam(java.lang.String name,
                   java.lang.String value)

Adds a parameter and its value.

Parameters:

name - The name of the parameter

value - The value of the parameter

setParam

FormBuilder setParam(java.lang.String name,
                   java.lang.Iterable<java.lang.String> values)

Sets multiple values for the named parameter, resetting any existing values in the process.

Parameters:

name - The name of the parameter

values - all values for the named the parameter

build

B build()