com.atlassian.httpclient.api

Interface FormBuilder

All Superinterfaces:

EntityBuilder

public interface FormBuilder
extends EntityBuilder

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

Nested Class Summary

Nested classes/interfaces inherited from interface com.atlassian.httpclient.api.EntityBuilder

EntityBuilder.Entity

Method Summary

Methods

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

Methods inherited from interface com.atlassian.httpclient.api.EntityBuilder

build

Method Detail

addParam

FormBuilder addParam(java.lang.String name)

Adds a valueless parameter.

Parameters:

name - The name of the parameter

Returns:

This object, for builder-style chaining

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

Returns:

This object, for builder-style chaining

setParam

FormBuilder setParam(java.lang.String name,
                   java.util.List<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 - A list of all values for the named the parameter

Returns:

This object, for builder-style chaining