Package org.apache.http.message
Class BasicLineFormatter
- java.lang.Object
-
- org.apache.http.message.BasicLineFormatter
-
- All Implemented Interfaces:
LineFormatter
@Contract(threading=IMMUTABLE) public class BasicLineFormatter extends java.lang.Object implements LineFormatter
Interface for formatting elements of the HEAD section of an HTTP message. This is the complement toLineParser
. 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 Description static BasicLineFormatter
DEFAULT
Deprecated.(4.3) useINSTANCE
static BasicLineFormatter
INSTANCE
-
Constructor Summary
Constructors Constructor Description BasicLineFormatter()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description CharArrayBuffer
appendProtocolVersion(CharArrayBuffer buffer, ProtocolVersion version)
Formats a protocol version.protected void
doFormatHeader(CharArrayBuffer buffer, Header header)
Actually formats a header.protected void
doFormatRequestLine(CharArrayBuffer buffer, RequestLine reqline)
Actually formats a request line.protected void
doFormatStatusLine(CharArrayBuffer buffer, StatusLine statline)
Actually formats a status line.protected int
estimateProtocolVersionLen(ProtocolVersion version)
Guesses the length of a formatted protocol version.static java.lang.String
formatHeader(Header header, LineFormatter formatter)
Formats a header.CharArrayBuffer
formatHeader(CharArrayBuffer buffer, Header header)
Formats a header.static java.lang.String
formatProtocolVersion(ProtocolVersion version, LineFormatter formatter)
Formats a protocol version.static java.lang.String
formatRequestLine(RequestLine reqline, LineFormatter formatter)
Formats a request line.CharArrayBuffer
formatRequestLine(CharArrayBuffer buffer, RequestLine reqline)
Formats a request line.static java.lang.String
formatStatusLine(StatusLine statline, LineFormatter formatter)
Formats a status line.CharArrayBuffer
formatStatusLine(CharArrayBuffer buffer, StatusLine statline)
Formats a status line.protected CharArrayBuffer
initBuffer(CharArrayBuffer charBuffer)
Obtains a buffer for formatting.
-
-
-
Field Detail
-
DEFAULT
@Deprecated public static final BasicLineFormatter DEFAULT
Deprecated.(4.3) useINSTANCE
A default instance of this class, for use as default or fallback. Note thatBasicLineFormatter
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 BasicLineFormatter INSTANCE
-
-
Method Detail
-
initBuffer
protected CharArrayBuffer initBuffer(CharArrayBuffer charBuffer)
Obtains a buffer for formatting.- Parameters:
charBuffer
- a buffer already available, ornull
- 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(ProtocolVersion version, LineFormatter formatter)
Formats a protocol version.- Parameters:
version
- the protocol version to formatformatter
- the formatter to use, ornull
for thedefault
- Returns:
- the formatted protocol version
-
appendProtocolVersion
public CharArrayBuffer appendProtocolVersion(CharArrayBuffer buffer, ProtocolVersion version)
Description copied from interface:LineFormatter
Formats a protocol version. This method does not follow the general contract forbuffer
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 namedformatProtocolVersion
.- Specified by:
appendProtocolVersion
in interfaceLineFormatter
- Parameters:
buffer
- a buffer to which to append, ornull
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 notnull
, the returned buffer is the argument buffer.
-
estimateProtocolVersionLen
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, ornull
- Returns:
- the estimated length of the formatted protocol version, in characters
-
formatRequestLine
public static java.lang.String formatRequestLine(RequestLine reqline, LineFormatter formatter)
Formats a request line.- Parameters:
reqline
- the request line to formatformatter
- the formatter to use, ornull
for thedefault
- Returns:
- the formatted request line
-
formatRequestLine
public CharArrayBuffer formatRequestLine(CharArrayBuffer buffer, RequestLine reqline)
Description copied from interface:LineFormatter
Formats a request line.- Specified by:
formatRequestLine
in interfaceLineFormatter
- Parameters:
buffer
- a buffer available for formatting, ornull
. The buffer will be cleared before use.reqline
- the request line to format- Returns:
- the formatted request line
-
doFormatRequestLine
protected void doFormatRequestLine(CharArrayBuffer buffer, RequestLine reqline)
Actually formats a request line. Called fromformatRequestLine(org.apache.http.RequestLine, org.apache.http.message.LineFormatter)
.- Parameters:
buffer
- the empty buffer into which to format, nevernull
reqline
- the request line to format, nevernull
-
formatStatusLine
public static java.lang.String formatStatusLine(StatusLine statline, LineFormatter formatter)
Formats a status line.- Parameters:
statline
- the status line to formatformatter
- the formatter to use, ornull
for thedefault
- Returns:
- the formatted status line
-
formatStatusLine
public CharArrayBuffer formatStatusLine(CharArrayBuffer buffer, StatusLine statline)
Description copied from interface:LineFormatter
Formats a status line.- Specified by:
formatStatusLine
in interfaceLineFormatter
- Parameters:
buffer
- a buffer available for formatting, ornull
. The buffer will be cleared before use.statline
- the status line to format- Returns:
- the formatted status line
-
doFormatStatusLine
protected void doFormatStatusLine(CharArrayBuffer buffer, StatusLine statline)
Actually formats a status line. Called fromformatStatusLine(org.apache.http.StatusLine, org.apache.http.message.LineFormatter)
.- Parameters:
buffer
- the empty buffer into which to format, nevernull
statline
- the status line to format, nevernull
-
formatHeader
public static java.lang.String formatHeader(Header header, LineFormatter formatter)
Formats a header.- Parameters:
header
- the header to formatformatter
- the formatter to use, ornull
for thedefault
- Returns:
- the formatted header
-
formatHeader
public CharArrayBuffer formatHeader(CharArrayBuffer buffer, Header header)
Description copied from interface:LineFormatter
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.
- Specified by:
formatHeader
in interfaceLineFormatter
- Parameters:
buffer
- a buffer available for formatting, ornull
. 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.
-
doFormatHeader
protected void doFormatHeader(CharArrayBuffer buffer, Header header)
Actually formats a header. Called fromformatHeader(org.apache.http.Header, org.apache.http.message.LineFormatter)
.- Parameters:
buffer
- the empty buffer into which to format, nevernull
header
- the header to format, nevernull
-
-