com.box.restclientv2.httpclientsupport

Class HttpClientURLEncodedUtils

java.lang.Object

com.box.restclientv2.httpclientsupport.HttpClientURLEncodedUtils

public class HttpClientURLEncodedUtils
extends java.lang.Object

A collection of utilities for encoding URLs.

Since:

4.0

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CONTENT_TYPE

Constructor Summary

Constructors

Constructor and Description
HttpClientURLEncodedUtils()

Method Summary

Methods

Modifier and Type	Method and Description
static java.lang.String	format(java.lang.Iterable<? extends org.apache.http.NameValuePair> parameters, java.nio.charset.Charset charset) Returns a String that is suitable for use as an application/x-www-form-urlencoded list of parameters in an HTTP PUT or HTTP POST.
static java.lang.String	format(java.util.List<? extends org.apache.http.NameValuePair> parameters, java.lang.String encoding) Returns a String that is suitable for use as an application/x-www-form-urlencoded list of parameters in an HTTP PUT or HTTP POST.
static boolean	isEncoded(org.apache.http.HttpEntity entity) Returns true if the entity's Content-Type header is application/x-www-form-urlencoded.
static void	parse(java.util.List<org.apache.http.NameValuePair> parameters, java.util.Scanner scanner, java.lang.String charset) Adds all parameters within the Scanner to the list of parameters, as encoded by encoding.
static java.util.List<org.apache.http.NameValuePair>	parse(java.lang.String s, java.nio.charset.Charset charset) Returns a list of NameValuePairs as parsed from the given string using the given character encoding.
static java.util.List<org.apache.http.NameValuePair>	parse(java.lang.String query, java.lang.String encoding) Returns a list of NameValuePairs as built from the URI's query portion.

Methods inherited from class java.lang.Object

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

Field Detail

CONTENT_TYPE

public static final java.lang.String CONTENT_TYPE

See Also:

Constant Field Values

Constructor Detail

HttpClientURLEncodedUtils

public HttpClientURLEncodedUtils()

Method Detail

parse

public static java.util.List<org.apache.http.NameValuePair> parse(java.lang.String query,
                                                  java.lang.String encoding)

Returns a list of NameValuePairs as built from the URI's query portion. For example, a URI of http://example.org/path/to/file?a=1&b=2&c=3 would return a list of three NameValuePairs, one for a=1, one for b=2, and one for c=3.

This is typically useful while parsing an HTTP PUT.

Parameters:

query - query to parse

encoding - encoding to use while parsing the query

isEncoded

public static boolean isEncoded(org.apache.http.HttpEntity entity)

Returns true if the entity's Content-Type header is application/x-www-form-urlencoded.

parse

public static void parse(java.util.List<org.apache.http.NameValuePair> parameters,
         java.util.Scanner scanner,
         java.lang.String charset)

Adds all parameters within the Scanner to the list of parameters, as encoded by encoding. For example, a scanner containing the string a=1&b=2&c=3 would add the NameValuePairs a=1, b=2, and c=3 to the list of parameters.

Parameters:

parameters - List to add parameters to.

scanner - Input that contains the parameters to parse.

charset - Encoding to use when decoding the parameters.

parse

public static java.util.List<org.apache.http.NameValuePair> parse(java.lang.String s,
                                                  java.nio.charset.Charset charset)

Returns a list of NameValuePairs as parsed from the given string using the given character encoding.

Parameters:

s - text to parse.

charset - Encoding to use when decoding the parameters.

Since:

4.2

format

public static java.lang.String format(java.util.List<? extends org.apache.http.NameValuePair> parameters,
                      java.lang.String encoding)

Returns a String that is suitable for use as an application/x-www-form-urlencoded list of parameters in an HTTP PUT or HTTP POST.

Parameters:

parameters - The parameters to include.

encoding - The encoding to use.

format

public static java.lang.String format(java.lang.Iterable<? extends org.apache.http.NameValuePair> parameters,
                      java.nio.charset.Charset charset)

Returns a String that is suitable for use as an application/x-www-form-urlencoded list of parameters in an HTTP PUT or HTTP POST.

Parameters:

parameters - The parameters to include.

charset - The encoding to use.

Since:

4.2