LineFormatter Interface Reference

Interface for formatting elements of the HEAD section of an HTTP message. More...

Inheritance diagram for LineFormatter:

Description

This is the complement to com.good.gd.apache.http.message.LineParser. There are individual methods for formatting a request line, a status line, or a header line. The formatting does not include the trailing line break sequence CR-LF. Instances of this interface are expected to be stateless and thread-safe.

The formatted lines are returned in memory, the formatter does not depend on any specific IO mechanism. In order to avoid unnecessary creation of temporary objects, a buffer can be passed as argument to all formatting methods. The implementation may or may not actually use that buffer for formatting. If it is used, the buffer will first be cleared by the formatXXX methods. The argument buffer can always be re-used after the call. The buffer returned as the result, if it is different from the argument buffer, MUST NOT be modified.

Author

Roland Weber

Version

Revision

573864

Date

2007-09-08 08:53:25 -0700 (Sat, 08 Sep 2007)

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	appendProtocolVersion (CharArrayBuffer buffer, ProtocolVersion version)
	Formats a protocol version. More...
CharArrayBuffer	formatRequestLine (CharArrayBuffer buffer, RequestLine reqline)
	Formats a request line. More...
CharArrayBuffer	formatStatusLine (CharArrayBuffer buffer, StatusLine statline)
	Formats a status line. More...
CharArrayBuffer	formatHeader (CharArrayBuffer buffer, Header header)
	Formats a header. More...

Member Function Documentation

appendProtocolVersion()

CharArrayBuffer appendProtocolVersion	(	CharArrayBuffer	buffer,
		ProtocolVersion	version
	)

This method does not follow the general contract for buffer arguments. It does not clear the argument buffer, but appends instead. The returned buffer can always be modified by the caller. Because of these differing conventions, it is not named formatProtocolVersion.

Parameters

buffer	a buffer to which to append, or null
version	the protocol version to format

Returns

a buffer with the formatted protocol version appended. The caller is allowed to modify the result buffer. If the buffer argument is not null, the returned buffer is the argument buffer.

Implemented in BasicLineFormatter.

formatRequestLine()

CharArrayBuffer formatRequestLine	(	CharArrayBuffer	buffer,
		RequestLine	reqline
	)

Parameters

buffer	a buffer available for formatting, or null. The buffer will be cleared before use.
reqline	the request line to format

Returns

the formatted request line

Implemented in BasicLineFormatter.

formatStatusLine()

CharArrayBuffer formatStatusLine	(	CharArrayBuffer	buffer,
		StatusLine	statline
	)

Parameters

buffer	a buffer available for formatting, or null. The buffer will be cleared before use.
statline	the status line to format

Returns

the formatted status line

Exceptions

ParseException

in case of a parse error

Implemented in BasicLineFormatter.

formatHeader()

CharArrayBuffer formatHeader	(	CharArrayBuffer	buffer,
		Header	header
	)

Due to header continuation, the result may be multiple lines. In order to generate well-formed HTTP, the lines in the result must be separated by the HTTP line break sequence CR-LF. There is no trailing CR-LF in the result.
See the class comment for details about the buffer argument.

Parameters

buffer	a buffer available for formatting, or null. The buffer will be cleared before use.
header	the header to format

Returns

a buffer holding the formatted header, never null. The returned buffer may be different from the argument buffer.

Exceptions

ParseException

in case of a parse error

Implemented in BasicLineFormatter.