|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES All Classes | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.http.message.BasicHeaderValueFormatter
@Contract(threading=IMMUTABLE) public class 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.
Field Summary | |
---|---|
static BasicHeaderValueFormatter |
DEFAULT
Deprecated. (4.3) use INSTANCE |
static BasicHeaderValueFormatter |
INSTANCE
|
static String |
SEPARATORS
Special characters that can be used as separators in HTTP parameters. |
static String |
UNSAFE_CHARS
Unsafe special characters that must be escaped using the backslash character |
Constructor Summary | |
---|---|
BasicHeaderValueFormatter()
|
Method Summary | |
---|---|
protected void |
doFormatValue(CharArrayBuffer buffer,
String value,
boolean quote)
Actually formats the value of a name-value pair. |
protected int |
estimateElementsLen(HeaderElement[] elems)
Estimates the length of formatted header elements. |
protected int |
estimateHeaderElementLen(HeaderElement elem)
Estimates the length of a formatted header element. |
protected int |
estimateNameValuePairLen(NameValuePair nvp)
Estimates the length of a formatted name-value pair. |
protected int |
estimateParametersLen(NameValuePair[] nvps)
Estimates the length of formatted parameters. |
CharArrayBuffer |
formatElements(CharArrayBuffer charBuffer,
HeaderElement[] elems,
boolean quote)
Formats an array of header elements. |
static String |
formatElements(HeaderElement[] elems,
boolean quote,
HeaderValueFormatter formatter)
Formats an array of header elements. |
CharArrayBuffer |
formatHeaderElement(CharArrayBuffer charBuffer,
HeaderElement elem,
boolean quote)
Formats one header element. |
static String |
formatHeaderElement(HeaderElement elem,
boolean quote,
HeaderValueFormatter formatter)
Formats a header element. |
CharArrayBuffer |
formatNameValuePair(CharArrayBuffer charBuffer,
NameValuePair nvp,
boolean quote)
Formats one name-value pair, where the value is optional. |
static String |
formatNameValuePair(NameValuePair nvp,
boolean quote,
HeaderValueFormatter formatter)
Formats a name-value pair. |
CharArrayBuffer |
formatParameters(CharArrayBuffer charBuffer,
NameValuePair[] nvps,
boolean quote)
Formats the parameters of a header element. |
static String |
formatParameters(NameValuePair[] nvps,
boolean quote,
HeaderValueFormatter formatter)
Formats a set of parameters. |
protected boolean |
isSeparator(char ch)
Checks whether a character is a separator . |
protected boolean |
isUnsafe(char ch)
Checks whether a character is unsafe . |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
@Deprecated public static final BasicHeaderValueFormatter DEFAULT
INSTANCE
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.
public static final BasicHeaderValueFormatter INSTANCE
public static final String SEPARATORS
public static final String UNSAFE_CHARS
Constructor Detail |
---|
public BasicHeaderValueFormatter()
Method Detail |
---|
public static String formatElements(HeaderElement[] elems, boolean quote, HeaderValueFormatter formatter)
elems
- the header elements to formatquote
- true
to always format with quoted values,
false
to use quotes only when necessaryformatter
- the formatter to use, or null
for the default
public CharArrayBuffer formatElements(CharArrayBuffer charBuffer, HeaderElement[] elems, boolean quote)
HeaderValueFormatter
formatElements
in interface HeaderValueFormatter
charBuffer
- the buffer to append to, or
null
to create a new bufferelems
- the header elements to formatquote
- 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.protected int estimateElementsLen(HeaderElement[] elems)
elems
- the header elements to format, or null
public static String formatHeaderElement(HeaderElement elem, boolean quote, HeaderValueFormatter formatter)
elem
- the header element to formatquote
- true
to always format with quoted values,
false
to use quotes only when necessaryformatter
- the formatter to use, or null
for the default
public CharArrayBuffer formatHeaderElement(CharArrayBuffer charBuffer, HeaderElement elem, boolean quote)
HeaderValueFormatter
formatHeaderElement
in interface HeaderValueFormatter
charBuffer
- the buffer to append to, or
null
to create a new bufferelem
- the header element to formatquote
- 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.protected int estimateHeaderElementLen(HeaderElement elem)
elem
- the header element to format, or null
public static String formatParameters(NameValuePair[] nvps, boolean quote, HeaderValueFormatter formatter)
nvps
- the parameters to formatquote
- true
to always format with quoted values,
false
to use quotes only when necessaryformatter
- the formatter to use, or null
for the default
public CharArrayBuffer formatParameters(CharArrayBuffer charBuffer, NameValuePair[] nvps, boolean quote)
HeaderValueFormatter
formatParameters
in interface HeaderValueFormatter
charBuffer
- the buffer to append to, or
null
to create a new buffernvps
- the parameters (name-value pairs) to formatquote
- 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.protected int estimateParametersLen(NameValuePair[] nvps)
nvps
- the parameters to format, or null
public static String formatNameValuePair(NameValuePair nvp, boolean quote, HeaderValueFormatter formatter)
nvp
- the name-value pair to formatquote
- true
to always format with a quoted value,
false
to use quotes only when necessaryformatter
- the formatter to use, or null
for the default
public CharArrayBuffer formatNameValuePair(CharArrayBuffer charBuffer, NameValuePair nvp, boolean quote)
HeaderValueFormatter
formatNameValuePair
in interface HeaderValueFormatter
charBuffer
- the buffer to append to, or
null
to create a new buffernvp
- the name-value pair to formatquote
- 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.protected int estimateNameValuePairLen(NameValuePair nvp)
nvp
- the name-value pair to format, or null
protected void doFormatValue(CharArrayBuffer buffer, String value, boolean quote)
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 necessaryprotected boolean isSeparator(char ch)
separator
.
ch
- the character to check
true
if the character is a separator,
false
otherwiseprotected boolean isUnsafe(char ch)
unsafe
.
ch
- the character to check
true
if the character is unsafe,
false
otherwise
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES All Classes | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |