Android

org.apache.http.message.BasicLineFormatter

java.lang.Object
org.apache.http.message.BasicLineFormatter 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. The formatted lines are returned in memory, the formatter does not depend on any specific IO mechanism. Instances of this interface are expected to be stateless and thread-safe.

Summary

Constants

      Value  
BasicLineFormatter  DEFAULT  A default instance of this class, for use as default or fallback.     

Public Constructors

            BasicLineFormatter()

Public Methods

          CharArrayBuffer  appendProtocolVersion(CharArrayBuffer buffer, ProtocolVersion version)
Formats a protocol version.
    final  static    String  formatHeader(Header header, LineFormatter formatter)
Formats a header.
          CharArrayBuffer  formatHeader(CharArrayBuffer buffer, Header header)
Formats a header.
    final  static    String  formatProtocolVersion(ProtocolVersion version, LineFormatter formatter)
Formats a protocol version.
    final  static    String  formatRequestLine(RequestLine reqline, LineFormatter formatter)
Formats a request line.
          CharArrayBuffer  formatRequestLine(CharArrayBuffer buffer, RequestLine reqline)
Formats a request line.
    final  static    String  formatStatusLine(StatusLine statline, LineFormatter formatter)
Formats a status line.
          CharArrayBuffer  formatStatusLine(CharArrayBuffer buffer, StatusLine statline)
Formats a status line.

Protected Methods

          void  doFormatHeader(CharArrayBuffer buffer, Header header)
Actually formats a header.
          void  doFormatRequestLine(CharArrayBuffer buffer, RequestLine reqline)
Actually formats a request line.
          void  doFormatStatusLine(CharArrayBuffer buffer, StatusLine statline)
Actually formats a status line.
          int  estimateProtocolVersionLen(ProtocolVersion version)
Guesses the length of a formatted protocol version.
          CharArrayBuffer  initBuffer(CharArrayBuffer buffer)
Obtains a buffer for formatting.
Methods inherited from class java.lang.Object
Methods inherited from interface org.apache.http.message.LineFormatter

Details

Constants

public static final BasicLineFormatter DEFAULT

A default instance of this class, for use as default or fallback. Note that BasicLineFormatter is not a singleton, there can be many instances of the class itself and of derived classes. The instance here provides non-customized, default behavior.

Public Constructors

public BasicLineFormatter()

Public Methods

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.

public static final String formatHeader(Header header, LineFormatter formatter)

Formats a header.

Parameters

header the header to format
formatter the formatter to use, or null for the default

Returns

  • the formatted header

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.

public static final String formatProtocolVersion(ProtocolVersion version, LineFormatter formatter)

Formats a protocol version.

Parameters

version the protocol version to format
formatter the formatter to use, or null for the default

Returns

  • the formatted protocol version

public static final String formatRequestLine(RequestLine reqline, LineFormatter formatter)

Formats a request line.

Parameters

reqline the request line to format
formatter the formatter to use, or null for the default

Returns

  • the formatted request line

public CharArrayBuffer formatRequestLine(CharArrayBuffer buffer, RequestLine reqline)

Formats a request line.

public static final String formatStatusLine(StatusLine statline, LineFormatter formatter)

Formats a status line.

Parameters

statline the status line to format
formatter the formatter to use, or null for the default

Returns

  • the formatted status line

public CharArrayBuffer formatStatusLine(CharArrayBuffer buffer, StatusLine statline)

Formats a status line.

Protected Methods

protected void doFormatHeader(CharArrayBuffer buffer, Header header)

Actually formats a header. Called from formatHeader(Header, LineFormatter).

Parameters

buffer the empty buffer into which to format, never null
header the header to format, never null

protected void doFormatRequestLine(CharArrayBuffer buffer, RequestLine reqline)

Actually formats a request line. Called from formatRequestLine(RequestLine, LineFormatter).

Parameters

buffer the empty buffer into which to format, never null
reqline the request line to format, never null

protected void doFormatStatusLine(CharArrayBuffer buffer, StatusLine statline)

Actually formats a status line. Called from formatStatusLine(StatusLine, LineFormatter).

Parameters

buffer the empty buffer into which to format, never null
statline the status line to format, never null

protected int estimateProtocolVersionLen(ProtocolVersion version)

Guesses the length of a formatted protocol version. Needed to guess the length of a formatted request or status line.

Parameters

version the protocol version to format, or null

Returns

  • the estimated length of the formatted protocol version, in characters

protected CharArrayBuffer initBuffer(CharArrayBuffer buffer)

Obtains a buffer for formatting.

Parameters

buffer a buffer already available, or null

Returns

  • the cleared argument buffer if there is one, or a new empty buffer that can be used for formatting
Copyright 2007 Google Inc. Build 0.9_r1-98467 - 14 Aug 2008 18:56