java.lang.Object | |
↳ | org.apache.http.message.BasicHeaderValueFormatter |
Basic implementation for formatting header value elements. Instances of this class are stateless and thread-safe. Derived classes are expected to maintain these properties.
Constants | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
String | SEPARATORS | Special characters that can be used as separators in HTTP parameters. | |||||||||
String | UNSAFE_CHARS | Unsafe special characters that must be escaped using the backslash character |
Fields | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
DEFAULT | A default instance of this class, for use as default or fallback. |
Public Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Formats an array of header elements.
| |||||||||||
Formats an array of header elements.
| |||||||||||
Formats a header element.
| |||||||||||
Formats one header element.
| |||||||||||
Formats one name-value pair, where the value is optional.
| |||||||||||
Formats a name-value pair.
| |||||||||||
Formats a set of parameters.
| |||||||||||
Formats the parameters of a header element.
|
Protected Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Actually formats the value of a name-value pair.
| |||||||||||
Estimates the length of formatted header elements.
| |||||||||||
Estimates the length of a formatted header element.
| |||||||||||
Estimates the length of a formatted name-value pair.
| |||||||||||
Estimates the length of formatted parameters.
| |||||||||||
Checks whether a character is a
separator .
| |||||||||||
Checks whether a character is
unsafe .
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
![]() | |||||||||||
![]() |
Special characters that can be used as separators in HTTP parameters. These special characters MUST be in a quoted string to be used within a parameter value .
Unsafe special characters that must be escaped using the backslash character
A default instance of this class, for use as default or fallback.
Note that BasicHeaderValueFormatter
is not a singleton, there
can be many instances of the class itself and of derived classes.
The instance here provides non-customized, default behavior.
Formats an array of header elements.
elems | the header elements to format |
---|---|
quote | true to always format with quoted values,
false to use quotes only when necessary |
formatter | the formatter to use, or null
for the default |
Formats an array of header elements.
buffer | the buffer to append to, or
null to create a new buffer |
---|---|
elems | the header elements to format |
quote | true to always format with quoted values,
false to use quotes only when necessary |
buffer
argument was not null
,
that buffer will be used and returned.
Formats a header element.
elem | the header element to format |
---|---|
quote | true to always format with quoted values,
false to use quotes only when necessary |
formatter | the formatter to use, or null
for the default |
Formats one header element.
buffer | the buffer to append to, or
null to create a new buffer |
---|---|
elem | the header element to format |
quote | true to always format with quoted values,
false to use quotes only when necessary |
buffer
argument was not null
,
that buffer will be used and returned.
Formats one name-value pair, where the value is optional.
buffer | the buffer to append to, or
null to create a new buffer |
---|---|
nvp | the name-value pair to format |
quote | true to always format with a quoted value,
false to use quotes only when necessary |
buffer
argument was not null
,
that buffer will be used and returned.
Formats a name-value pair.
nvp | the name-value pair to format |
---|---|
quote | true to always format with a quoted value,
false to use quotes only when necessary |
formatter | the formatter to use, or null
for the default |
Formats a set of parameters.
nvps | the parameters to format |
---|---|
quote | true to always format with quoted values,
false to use quotes only when necessary |
formatter | the formatter to use, or null
for the default |
Formats the parameters of a header element. That's a list of name-value pairs, to be separated by semicolons. This method will not generate a leading semicolon.
buffer | the buffer to append to, or
null to create a new buffer |
---|---|
nvps | the parameters (name-value pairs) to format |
quote | true to always format with quoted values,
false to use quotes only when necessary |
buffer
argument was not null
,
that buffer will be used and returned.
Actually formats the value of a name-value pair.
This does not include a leading = character.
Called from formatNameValuePair
.
buffer | the buffer to append to, never null |
---|---|
value | the value to append, never null |
quote | true to always format with quotes,
false to use quotes only when necessary
|
Estimates the length of formatted header elements.
elems | the header elements to format, or null |
---|
Estimates the length of a formatted header element.
elem | the header element to format, or null |
---|
Estimates the length of a formatted name-value pair.
nvp | the name-value pair to format, or null |
---|
Estimates the length of formatted parameters.
nvps | the parameters to format, or null |
---|
Checks whether a character is a separator
.
ch | the character to check |
---|
true
if the character is a separator,
false
otherwise
Checks whether a character is unsafe
.
ch | the character to check |
---|
true
if the character is unsafe,
false
otherwise