public interface HeaderValueFormatter
HeaderValueParser.
Instances of this interface are expected to be stateless and thread-safe.
All formatting methods accept an optional buffer argument. If a buffer is passed in, the formatted element will be appended and the modified buffer is returned. If no buffer is passed in, a new buffer will be created and filled with the formatted element. In both cases, the caller is allowed to modify the returned buffer.
| Modifier and Type | Method and Description |
|---|---|
CharArrayBuffer |
formatElements(CharArrayBuffer buffer,
HeaderElement[] elems,
boolean quote)
Formats an array of header elements.
|
CharArrayBuffer |
formatHeaderElement(CharArrayBuffer buffer,
HeaderElement elem,
boolean quote)
Formats one header element.
|
CharArrayBuffer |
formatNameValuePair(CharArrayBuffer buffer,
NameValuePair nvp,
boolean quote)
Formats one name-value pair, where the value is optional.
|
CharArrayBuffer |
formatParameters(CharArrayBuffer buffer,
NameValuePair[] nvps,
boolean quote)
Formats the parameters of a header element.
|
CharArrayBuffer formatElements(CharArrayBuffer buffer, HeaderElement[] elems, boolean quote)
buffer - 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 necessarybuffer argument was not null,
that buffer will be used and returned.CharArrayBuffer formatHeaderElement(CharArrayBuffer buffer, HeaderElement elem, boolean quote)
buffer - 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 necessarybuffer argument was not null,
that buffer will be used and returned.CharArrayBuffer formatParameters(CharArrayBuffer buffer, NameValuePair[] nvps, boolean quote)
buffer - 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 necessarybuffer argument was not null,
that buffer will be used and returned.CharArrayBuffer formatNameValuePair(CharArrayBuffer buffer, NameValuePair nvp, boolean quote)
buffer - 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 necessarybuffer argument was not null,
that buffer will be used and returned.Copyright © 2005–2022 The Apache Software Foundation. All rights reserved.