Top Description Methods
org.apache.http.message

public Interface HeaderValueFormatter

Known Direct Implementers
org.apache.http.message.BasicHeaderValueFormatter
Imports
org.apache.http.HeaderElement, .NameValuePair, org.apache.http.util.CharArrayBuffer

Interface for formatting elements of a header value. This is the complement to 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.

Since
4.0

Method Summary

Modifier and TypeMethod and Description
public CharArrayBuffer

Returns:

a buffer with the formatted header elements. If the buffer argument was not null, that buffer will be used and returned.
formatElements
(CharArrayBuffer
the buffer to append to, or null to create a new buffer
buffer
,
HeaderElement[]
the header elements to format
elems
,
boolean
true to always format with quoted values, false to use quotes only when necessary
quote
)

Formats an array of header elements.

public CharArrayBuffer

Returns:

a buffer with the formatted header element. If the buffer argument was not null, that buffer will be used and returned.
formatHeaderElement
(CharArrayBuffer
the buffer to append to, or null to create a new buffer
buffer
,
HeaderElement
the header element to format
elem
,
boolean
true to always format with quoted values, false to use quotes only when necessary
quote
)

Formats one header element.

public CharArrayBuffer

Returns:

a buffer with the formatted name-value pair. If the buffer argument was not null, that buffer will be used and returned.
formatNameValuePair
(CharArrayBuffer
the buffer to append to, or null to create a new buffer
buffer
,
NameValuePair
the name-value pair to format
nvp
,
boolean
true to always format with a quoted value, false to use quotes only when necessary
quote
)

Formats one name-value pair, where the value is optional.

public CharArrayBuffer

Returns:

a buffer with the formatted parameters. If the buffer argument was not null, that buffer will be used and returned.
formatParameters
(CharArrayBuffer
the buffer to append to, or null to create a new buffer
buffer
,
NameValuePair[]
the parameters (name-value pairs) to format
nvps
,
boolean
true to always format with quoted values, false to use quotes only when necessary
quote
)

Formats the parameters of a header element.

Method Detail

formatElementsback to summary
public CharArrayBuffer formatElements(CharArrayBuffer buffer, HeaderElement[] elems, boolean quote)

Formats an array of header elements.

Parameters
buffer:CharArrayBuffer

the buffer to append to, or null to create a new buffer

elems:HeaderElement[]

the header elements to format

quote:boolean

true to always format with quoted values, false to use quotes only when necessary

Returns:CharArrayBuffer

a buffer with the formatted header elements. If the buffer argument was not null, that buffer will be used and returned.

formatHeaderElementback to summary
public CharArrayBuffer formatHeaderElement(CharArrayBuffer buffer, HeaderElement elem, boolean quote)

Formats one header element.

Parameters
buffer:CharArrayBuffer

the buffer to append to, or null to create a new buffer

elem:HeaderElement

the header element to format

quote:boolean

true to always format with quoted values, false to use quotes only when necessary

Returns:CharArrayBuffer

a buffer with the formatted header element. If the buffer argument was not null, that buffer will be used and returned.

formatNameValuePairback to summary
public CharArrayBuffer formatNameValuePair(CharArrayBuffer buffer, NameValuePair nvp, boolean quote)

Formats one name-value pair, where the value is optional.

Parameters
buffer:CharArrayBuffer

the buffer to append to, or null to create a new buffer

nvp:NameValuePair

the name-value pair to format

quote:boolean

true to always format with a quoted value, false to use quotes only when necessary

Returns:CharArrayBuffer

a buffer with the formatted name-value pair. If the buffer argument was not null, that buffer will be used and returned.

formatParametersback to summary
public CharArrayBuffer formatParameters(CharArrayBuffer buffer, NameValuePair[] nvps, boolean quote)

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.

Parameters
buffer:CharArrayBuffer

the buffer to append to, or null to create a new buffer

nvps:NameValuePair[]

the parameters (name-value pairs) to format

quote:boolean

true to always format with quoted values, false to use quotes only when necessary

Returns:CharArrayBuffer

a buffer with the formatted parameters. If the buffer argument was not null, that buffer will be used and returned.