com.couchbase.client.java.cluster.api

Class Form

java.lang.Object

com.couchbase.client.java.cluster.api.Form

@InterfaceAudience.Public
 @InterfaceStability.Experimental
public class Form
extends Object

A utility method / builder class to create form bodies for a RestBuilder or AsyncRestBuilder.

Since:

2.3.2

Author:

Simon Baslé

Method Summary

Modifier and Type	Method and Description
Form	add(String paramName, String paramValue) Add a parameter entry to the Form.
static Form	create() Create an empty Form.
String	toUrlEncodedString() Encode the Form using the "application/x-www-form-urlencoded" Content-Type.

Methods inherited from class java.lang.Object

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

Method Detail

create

public static Form create()

Create an empty Form.

add

public Form add(String paramName,
                String paramValue)

Add a parameter entry to the Form.

toUrlEncodedString

public String toUrlEncodedString()

Encode the Form using the "application/x-www-form-urlencoded" Content-Type. Each form parameter is represented as "key=value" where both key and value are url-encoded.

Returns:

the url-encoded representation of the form.