org.apache.http.message

Class BasicLineFormatterHC4

java.lang.Object

org.apache.http.message.BasicLineFormatterHC4

All Implemented Interfaces:

org.apache.http.message.LineFormatter

@Immutable
public class BasicLineFormatterHC4
extends java.lang.Object
implements 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. 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.

Since:

4.0

Field Summary

Fields

Modifier and Type	Field and Description
static BasicLineFormatterHC4	DEFAULT Deprecated. (4.3) use INSTANCE
static BasicLineFormatterHC4	INSTANCE

Constructor Summary

Constructors

Constructor and Description
BasicLineFormatterHC4()

Method Summary

Methods

Modifier and Type	Method and Description
org.apache.http.util.CharArrayBuffer	appendProtocolVersion(org.apache.http.util.CharArrayBuffer buffer, org.apache.http.ProtocolVersion version)
protected void	doFormatHeader(org.apache.http.util.CharArrayBuffer buffer, org.apache.http.Header header) Actually formats a header.
protected void	doFormatRequestLine(org.apache.http.util.CharArrayBuffer buffer, org.apache.http.RequestLine reqline) Actually formats a request line.
protected void	doFormatStatusLine(org.apache.http.util.CharArrayBuffer buffer, org.apache.http.StatusLine statline) Actually formats a status line.
protected int	estimateProtocolVersionLen(org.apache.http.ProtocolVersion version) Guesses the length of a formatted protocol version.
org.apache.http.util.CharArrayBuffer	formatHeader(org.apache.http.util.CharArrayBuffer buffer, org.apache.http.Header header)
static java.lang.String	formatHeader(org.apache.http.Header header, org.apache.http.message.LineFormatter formatter) Formats a header.
static java.lang.String	formatProtocolVersion(org.apache.http.ProtocolVersion version, org.apache.http.message.LineFormatter formatter) Formats a protocol version.
org.apache.http.util.CharArrayBuffer	formatRequestLine(org.apache.http.util.CharArrayBuffer buffer, org.apache.http.RequestLine reqline)
static java.lang.String	formatRequestLine(org.apache.http.RequestLine reqline, org.apache.http.message.LineFormatter formatter) Formats a request line.
org.apache.http.util.CharArrayBuffer	formatStatusLine(org.apache.http.util.CharArrayBuffer buffer, org.apache.http.StatusLine statline)
static java.lang.String	formatStatusLine(org.apache.http.StatusLine statline, org.apache.http.message.LineFormatter formatter) Formats a status line.
protected org.apache.http.util.CharArrayBuffer	initBuffer(org.apache.http.util.CharArrayBuffer charBuffer) Obtains a buffer for formatting.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT

@Deprecated
public static final BasicLineFormatterHC4 DEFAULT

Deprecated. (4.3) use INSTANCE

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.

INSTANCE

public static final BasicLineFormatterHC4 INSTANCE

Constructor Detail

BasicLineFormatterHC4

public BasicLineFormatterHC4()

Method Detail

initBuffer

protected org.apache.http.util.CharArrayBuffer initBuffer(org.apache.http.util.CharArrayBuffer charBuffer)

Obtains a buffer for formatting.

Parameters:

charBuffer - 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

formatProtocolVersion

public static java.lang.String formatProtocolVersion(org.apache.http.ProtocolVersion version,
                                     org.apache.http.message.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

appendProtocolVersion

public org.apache.http.util.CharArrayBuffer appendProtocolVersion(org.apache.http.util.CharArrayBuffer buffer,
                                                         org.apache.http.ProtocolVersion version)

Specified by:

appendProtocolVersion in interface org.apache.http.message.LineFormatter

estimateProtocolVersionLen

protected int estimateProtocolVersionLen(org.apache.http.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

formatRequestLine

public static java.lang.String formatRequestLine(org.apache.http.RequestLine reqline,
                                 org.apache.http.message.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

formatRequestLine

public org.apache.http.util.CharArrayBuffer formatRequestLine(org.apache.http.util.CharArrayBuffer buffer,
                                                     org.apache.http.RequestLine reqline)

Specified by:

formatRequestLine in interface org.apache.http.message.LineFormatter

doFormatRequestLine

protected void doFormatRequestLine(org.apache.http.util.CharArrayBuffer buffer,
                       org.apache.http.RequestLine reqline)

Actually formats a request line. Called from formatRequestLine(org.apache.http.RequestLine, org.apache.http.message.LineFormatter).

Parameters:

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

reqline - the request line to format, never null

formatStatusLine

public static java.lang.String formatStatusLine(org.apache.http.StatusLine statline,
                                org.apache.http.message.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

formatStatusLine

public org.apache.http.util.CharArrayBuffer formatStatusLine(org.apache.http.util.CharArrayBuffer buffer,
                                                    org.apache.http.StatusLine statline)

Specified by:

formatStatusLine in interface org.apache.http.message.LineFormatter

doFormatStatusLine

protected void doFormatStatusLine(org.apache.http.util.CharArrayBuffer buffer,
                      org.apache.http.StatusLine statline)

Actually formats a status line. Called from formatStatusLine(org.apache.http.StatusLine, org.apache.http.message.LineFormatter).

Parameters:

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

statline - the status line to format, never null

formatHeader

public static java.lang.String formatHeader(org.apache.http.Header header,
                            org.apache.http.message.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

formatHeader

public org.apache.http.util.CharArrayBuffer formatHeader(org.apache.http.util.CharArrayBuffer buffer,
                                                org.apache.http.Header header)

Specified by:

formatHeader in interface org.apache.http.message.LineFormatter

doFormatHeader

protected void doFormatHeader(org.apache.http.util.CharArrayBuffer buffer,
                  org.apache.http.Header header)

Actually formats a header. Called from formatHeader(org.apache.http.Header, org.apache.http.message.LineFormatter).

Parameters:

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

header - the header to format, never null