Apache HttpComponents Core HTTP/1.1 5.2.4 · org.apache.hc.core5.net.URLEncodedUtils

Modifier and Type	Field and Description
private static final char	QP_SEP_A
private static final char	QP_SEP_S
private static final BitSet	URL_ENCODER

Access	Constructor and Description
public	URLEncodedUtils()

Method Summary

Modifier and Type	Method and Description
public static String	Returns: An `application/x-www-form-urlencoded` string format(final Iterable<? extends NameValuePair> The parameters to include. parameters, final char The parameter separator, by convention, `'&'` or `';'`. parameterSeparator, final Charset The encoding to use. 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.
public static String	Returns: An `application/x-www-form-urlencoded` string format(final Iterable<? extends NameValuePair> The parameters to include. parameters, final Charset The encoding to use. 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.
public static String	Returns: URI path component formatSegments(final Iterable<String> the segments. segments, final Charset parameter charset. charset) Returns a string consisting of joint encoded path segments.
public static String	Returns: URI path component formatSegments(final String... the segments. segments) Returns a string consisting of joint encoded path segments.
public static List<NameValuePair>	Returns: list of query parameters. parse(final URI input URI. uri, final Charset parameter charset. charset) Returns a list of `NameValuePair`s URI query parameters.
public static List<NameValuePair>	Returns: list of query parameters. parse(final CharSequence URI query component. s, final Charset charset to use when decoding the parameters. charset) Returns a list of `NameValuePair`s URI query parameters.
public static List<NameValuePair>	Returns: list of query parameters. parse(final CharSequence input text. s, final Charset parameter charset. charset, final char... parameter separators. separators) Returns a list of `NameValuePair`s parameters.
public static List<String>	Returns: list of segments. parsePathSegments(final CharSequence URI path component. s, final Charset parameter charset. charset) Returns a list of URI path segments.
public static List<String>	Returns: list of segments. parsePathSegments(final CharSequence URI path component. s) Returns a list of URI path segments.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

QP_SEP_A	back to summary
private static final char QP_SEP_A

QP_SEP_S	back to summary
private static final char QP_SEP_S

URL_ENCODER	back to summary
private static final BitSet URL_ENCODER

URLEncodedUtils	back to summary
public URLEncodedUtils()

Method Detail

format back to summary

format	back to summary
public static String format(final Iterable<? extends NameValuePair> parameters, final char parameterSeparator, final 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:Iterable<? extends NameValuePair> The parameters to include. parameterSeparator:char The parameter separator, by convention, `'&'` or `';'`. charset:Charset The encoding to use. Returns:String An `application/x-www-form-urlencoded` string Since 4.3

public static String format(final Iterable<? extends NameValuePair> parameters, final char parameterSeparator, final 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:Iterable<? extends NameValuePair>: The parameters to include.
parameterSeparator:char: The parameter separator, by convention, '&' or ';'.
charset:Charset: The encoding to use.

Returns:String

An application/x-www-form-urlencoded string

Since

4.3

format back to summary

format	back to summary
public static String format(final Iterable<? extends NameValuePair> parameters, final 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:Iterable<? extends NameValuePair> The parameters to include. charset:Charset The encoding to use. Returns:String An `application/x-www-form-urlencoded` string Since 4.2

public static String format(final Iterable<? extends NameValuePair> parameters, final 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:Iterable<? extends NameValuePair>: The parameters to include.
charset:Charset: The encoding to use.

Returns:String

An application/x-www-form-urlencoded string

Since

4.2

formatSegments	back to summary
public static String formatSegments(final Iterable<String> segments, final Charset charset) Returns a string consisting of joint encoded path segments. Parameters segments:Iterable<String> the segments. charset:Charset parameter charset. Returns:String URI path component Since 4.5

formatSegments

back to summary

public static String formatSegments(final Iterable<String> segments, final Charset charset)

Returns a string consisting of joint encoded path segments.

Parameters

segments:Iterable<String>: the segments.
charset:Charset: parameter charset.

Returns:String

URI path component

Since

4.5

formatSegments	back to summary
public static String formatSegments(final String... segments) Returns a string consisting of joint encoded path segments. Parameters segments:String[] the segments. Returns:String URI path component Since 4.5

formatSegments

back to summary

public static String formatSegments(final String... segments)

Returns a string consisting of joint encoded path segments.

Parameters

segments:String[]: the segments.

Returns:String

URI path component

Since

4.5

parse back to summary

parse	back to summary
public static List<NameValuePair> parse(final URI uri, final Charset charset) Returns a list of `NameValuePair`s URI query parameters. By convention, `'&'` and `';'` are accepted as parameter separators. Parameters uri:URI input URI. charset:Charset parameter charset. Returns:List<NameValuePair> list of query parameters. Since 4.5

public static List<NameValuePair> parse(final URI uri, final Charset charset)

Returns a list of NameValuePairs URI query parameters. By convention, '&' and ';' are accepted as parameter separators.

Parameters

uri:URI: input URI.
charset:Charset: parameter charset.

Returns:List<NameValuePair>

list of query parameters.

Since

4.5

parse back to summary

parse	back to summary
public static List<NameValuePair> parse(final CharSequence s, final Charset charset) Returns a list of `NameValuePair`s URI query parameters. By convention, `'&'` and `';'` are accepted as parameter separators. Parameters s:CharSequence URI query component. charset:Charset charset to use when decoding the parameters. Returns:List<NameValuePair> list of query parameters. Since 4.2

public static List<NameValuePair> parse(final CharSequence s, final Charset charset)

Returns a list of NameValuePairs URI query parameters. By convention, '&' and ';' are accepted as parameter separators.

Parameters

s:CharSequence: URI query component.
charset:Charset: charset to use when decoding the parameters.

Returns:List<NameValuePair>

list of query parameters.

Since

4.2

parse back to summary

parse	back to summary
public static List<NameValuePair> parse(final CharSequence s, final Charset charset, final char... separators) Returns a list of `NameValuePair`s parameters. Parameters s:CharSequence input text. charset:Charset parameter charset. separators:char[] parameter separators. Returns:List<NameValuePair> list of query parameters. Since 4.4

public static List<NameValuePair> parse(final CharSequence s, final Charset charset, final char... separators)

Returns a list of NameValuePairs parameters.

Parameters

s:CharSequence: input text.
charset:Charset: parameter charset.
separators:char[]: parameter separators.

Returns:List<NameValuePair>

list of query parameters.

Since

4.4

parsePathSegments	back to summary
public static List<String> parsePathSegments(final CharSequence s, final Charset charset) Returns a list of URI path segments. Parameters s:CharSequence URI path component. charset:Charset parameter charset. Returns:List<String> list of segments. Since 4.5

parsePathSegments

back to summary

public static List<String> parsePathSegments(final CharSequence s, final Charset charset)

Returns a list of URI path segments.

Parameters

s:CharSequence: URI path component.
charset:Charset: parameter charset.

Returns:List<String>

list of segments.

Since

4.5

parsePathSegments	back to summary
public static List<String> parsePathSegments(final CharSequence s) Returns a list of URI path segments. Parameters s:CharSequence URI path component. Returns:List<String> list of segments. Since 4.5

parsePathSegments

back to summary

public static List<String> parsePathSegments(final CharSequence s)

Returns a list of URI path segments.

Parameters

s:CharSequence: URI path component.

Returns:List<String>

list of segments.

Since

4.5

public Class URLEncodedUtils

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail