Apache HttpCore 4.4.16 · org.apache.http.message.LineFormatter

Interface for formatting elements of the HEAD section of an HTTP message. This is the complement to 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.

Method Summary

Modifier and Type	Method and Description
public CharArrayBuffer	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. appendProtocolVersion(CharArrayBuffer a buffer to which to append, or `null` buffer, ProtocolVersion the protocol version to format version) Formats a protocol version.
public CharArrayBuffer	Returns: a buffer holding the formatted header, never `null`. The returned buffer may be different from the argument buffer. formatHeader(CharArrayBuffer a buffer available for formatting, or `null`. The buffer will be cleared before use. buffer, Header the header to format header) Formats a header.
public CharArrayBuffer	Returns: the formatted request line formatRequestLine(CharArrayBuffer a buffer available for formatting, or `null`. The buffer will be cleared before use. buffer, RequestLine the request line to format reqline) Formats a request line.
public CharArrayBuffer	Returns: the formatted status line formatStatusLine(CharArrayBuffer a buffer available for formatting, or `null`. The buffer will be cleared before use. buffer, StatusLine the status line to format statline) Formats a status line.

Method Detail

appendProtocolVersion back to summary

appendProtocolVersion	back to summary
public CharArrayBuffer appendProtocolVersion(CharArrayBuffer buffer, ProtocolVersion version) Formats a protocol 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:CharArrayBuffer a buffer to which to append, or `null` version:ProtocolVersion the protocol version to format Returns:CharArrayBuffer 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.

public CharArrayBuffer appendProtocolVersion(CharArrayBuffer buffer, ProtocolVersion version)

Formats a protocol 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:CharArrayBuffer: a buffer to which to append, or null
version:ProtocolVersion: the protocol version to format

Returns:CharArrayBuffer

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.

formatHeader back to summary

formatHeader	back to summary
public CharArrayBuffer formatHeader(CharArrayBuffer buffer, Header header) Formats a 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:CharArrayBuffer a buffer available for formatting, or `null`. The buffer will be cleared before use. header:Header the header to format Returns:CharArrayBuffer 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

public CharArrayBuffer formatHeader(CharArrayBuffer buffer, Header header)

Formats a 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:CharArrayBuffer: a buffer available for formatting, or null. The buffer will be cleared before use.
header:Header: the header to format

Returns:CharArrayBuffer

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

formatRequestLine back to summary

formatRequestLine	back to summary
public CharArrayBuffer formatRequestLine(CharArrayBuffer buffer, RequestLine reqline) Formats a request line. Parameters buffer:CharArrayBuffer a buffer available for formatting, or `null`. The buffer will be cleared before use. reqline:RequestLine the request line to format Returns:CharArrayBuffer the formatted request line

public CharArrayBuffer formatRequestLine(CharArrayBuffer buffer, RequestLine reqline)

Formats a request line.

Parameters

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

Returns:CharArrayBuffer

the formatted request line

formatStatusLine back to summary

formatStatusLine	back to summary
public CharArrayBuffer formatStatusLine(CharArrayBuffer buffer, StatusLine statline) Formats a status line. Parameters buffer:CharArrayBuffer a buffer available for formatting, or `null`. The buffer will be cleared before use. statline:StatusLine the status line to format Returns:CharArrayBuffer the formatted status line Exceptions ParseException: in case of a parse error

public CharArrayBuffer formatStatusLine(CharArrayBuffer buffer, StatusLine statline)

Formats a status line.

Parameters

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

Returns:CharArrayBuffer

the formatted status line

Exceptions

ParseException:: in case of a parse error

public Interface LineFormatter

Method Summary

Method Detail