@Immutable public class URLEncodedUtils extends Object
Modifier and Type | Field and Description |
---|---|
static String |
CONTENT_TYPE
The default HTML form content type.
|
Constructor and Description |
---|
URLEncodedUtils() |
Modifier and Type | Method and Description |
---|---|
static String |
format(Iterable<? extends NameValuePair> parameters,
char parameterSeparator,
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 String |
format(Iterable<? extends NameValuePair> parameters,
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 String |
format(List<? extends NameValuePair> parameters,
char parameterSeparator,
String 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 String |
format(List<? extends NameValuePair> parameters,
String 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 boolean |
isEncoded(HttpEntity entity)
Returns true if the entity's Content-Type header is
application/x-www-form-urlencoded . |
static List<NameValuePair> |
parse(HttpEntity entity)
Returns a list of
NameValuePairs as parsed from an HttpEntity . |
static void |
parse(List<NameValuePair> parameters,
Scanner scanner,
String charset)
Adds all parameters within the Scanner to the list of
parameters , as encoded by
encoding . |
static void |
parse(List<NameValuePair> parameters,
Scanner scanner,
String parameterSepartorPattern,
String charset)
Adds all parameters within the Scanner to the list of
parameters , as encoded by encoding . |
static List<NameValuePair> |
parse(String s,
Charset charset)
Returns a list of
NameValuePairs as parsed from the given string using the given character
encoding. |
static List<NameValuePair> |
parse(String s,
Charset charset,
char... parameterSeparator)
Returns a list of
NameValuePairs as parsed from the given string using the given character
encoding. |
static List<NameValuePair> |
parse(URI uri,
String charset)
Returns a list of
NameValuePairs as built from the URI's query portion. |
public static final String CONTENT_TYPE
public static List<NameValuePair> parse(URI uri, String charset)
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. By convention, '&'
and ';'
are accepted as parameter separators.
This is typically useful while parsing an HTTP PUT. This API is currently only used for testing.
uri
- URI to parsecharset
- Charset name to use while parsing the queryNameValuePair
as built from the URI's query portion.public static List<NameValuePair> parse(HttpEntity entity) throws IOException
NameValuePairs
as parsed from an HttpEntity
. The encoding is
taken from the entity's Content-Encoding header.
This is typically used while parsing an HTTP POST.
entity
- The entity to parseNameValuePair
as built from the URI's query portion.IOException
- If there was an exception getting the entity's data.public static boolean isEncoded(HttpEntity entity)
application/x-www-form-urlencoded
.public static void parse(List<NameValuePair> parameters, Scanner scanner, String charset)
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. By convention, '&'
and
';'
are accepted as parameter separators.parameters
- List to add parameters to.scanner
- Input that contains the parameters to parse.charset
- Encoding to use when decoding the parameters.public static void parse(List<NameValuePair> parameters, Scanner scanner, String parameterSepartorPattern, String charset)
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
- List to add parameters to.scanner
- Input that contains the parameters to parse.parameterSepartorPattern
- The Pattern string for parameter separators, by convention "[&;]"
charset
- Encoding to use when decoding the parameters.public static List<NameValuePair> parse(String s, Charset charset)
NameValuePairs
as parsed from the given string using the given character
encoding. By convention, '&'
and ';'
are accepted as parameter separators.s
- text to parse.charset
- Encoding to use when decoding the parameters.NameValuePair
as built from the URI's query portion.public static List<NameValuePair> parse(String s, Charset charset, char... parameterSeparator)
NameValuePairs
as parsed from the given string using the given character
encoding.s
- text to parse.charset
- Encoding to use when decoding the parameters.parameterSeparator
- The characters used to separate parameters, by convention, '&'
and ';'
.NameValuePair
as built from the URI's query portion.public static String format(List<? extends NameValuePair> parameters, String charset)
application/x-www-form-urlencoded
list of parameters in an HTTP PUT or HTTP POST.parameters
- The parameters to include.charset
- The encoding to use.application/x-www-form-urlencoded
stringpublic static String format(List<? extends NameValuePair> parameters, char parameterSeparator, String charset)
application/x-www-form-urlencoded
list of parameters in an HTTP PUT or HTTP POST.parameters
- The parameters to include.parameterSeparator
- The parameter separator, by convention, '&'
or ';'
.charset
- The encoding to use.application/x-www-form-urlencoded
stringpublic static String format(Iterable<? extends NameValuePair> parameters, Charset charset)
application/x-www-form-urlencoded
list of parameters in an HTTP PUT or HTTP POST.parameters
- The parameters to include.charset
- The encoding to use.application/x-www-form-urlencoded
stringpublic static String format(Iterable<? extends NameValuePair> parameters, char parameterSeparator, Charset charset)
application/x-www-form-urlencoded
list of parameters in an HTTP PUT or HTTP POST.parameters
- The parameters to include.parameterSeparator
- The parameter separator, by convention, '&'
or ';'
.charset
- The encoding to use.application/x-www-form-urlencoded
stringCopyright © 1999–2013 The Apache Software Foundation. All rights reserved.