HeaderValueFormatter Interface Reference

Interface for formatting elements of a header value. More...

Inheritance diagram for HeaderValueFormatter:

Description

This is the complement to com.good.gd.apache.http.message.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.

Version

Revision

571954

Since

4.0

Notice

The following notice applies to the original API on which this API is based, and to its documentation. The documentation of this API has been revised from the original.

/*
 * Copyright (C) 2006 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

Public Member Functions
CharArrayBuffer	formatElements (CharArrayBuffer buffer, HeaderElement[] elems, boolean quote)
	Formats an array of header elements. More...
CharArrayBuffer	formatHeaderElement (CharArrayBuffer buffer, HeaderElement elem, boolean quote)
	Formats one header element. More...
CharArrayBuffer	formatParameters (CharArrayBuffer buffer, NameValuePair[] nvps, boolean quote)
	Formats the parameters of a header element. More...
CharArrayBuffer	formatNameValuePair (CharArrayBuffer buffer, NameValuePair nvp, boolean quote)
	Formats one name-value pair, where the value is optional. More...

Member Function Documentation

formatElements()

CharArrayBuffer formatElements	(	CharArrayBuffer	buffer,
		HeaderElement[]	elems,
		boolean	quote
	)

Parameters

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

Returns

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

Implemented in BasicHeaderValueFormatter.

formatHeaderElement()

CharArrayBuffer formatHeaderElement	(	CharArrayBuffer	buffer,
		HeaderElement	elem,
		boolean	quote
	)

Parameters

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

Returns

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

Implemented in BasicHeaderValueFormatter.

formatParameters()

CharArrayBuffer formatParameters	(	CharArrayBuffer	buffer,
		NameValuePair[]	nvps,
		boolean	quote
	)

That's a list of name-value pairs, to be separated by semicolons. This method will not generate a leading semicolon.

Parameters

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

Returns

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

Implemented in BasicHeaderValueFormatter.

formatNameValuePair()

CharArrayBuffer formatNameValuePair	(	CharArrayBuffer	buffer,
		NameValuePair	nvp,
		boolean	quote
	)

Parameters

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

Returns

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

Implemented in BasicHeaderValueFormatter.