1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
|
/*
* ====================================================================
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you 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.
* ====================================================================
*
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation. For more
* information on the Apache Software Foundation, please see
* <http://www.apache.org/>.
*
*/
package ch.boye.httpclientandroidlib.message;
import ch.boye.httpclientandroidlib.Header;
import ch.boye.httpclientandroidlib.ProtocolVersion;
import ch.boye.httpclientandroidlib.RequestLine;
import ch.boye.httpclientandroidlib.StatusLine;
import ch.boye.httpclientandroidlib.util.CharArrayBuffer;
/**
* Interface for formatting elements of the HEAD section of an HTTP message.
* This is the complement to {@link LineParser}.
* There are individual methods for formatting a request line, a
* status line, or a header line. The formatting does <i>not</i> include the
* trailing line break sequence CR-LF.
* Instances of this interface are expected to be stateless and thread-safe.
*
* <p>
* 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
* <code>formatXXX</code> 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.
* </p>
*
* @since 4.0
*/
public interface LineFormatter {
/**
* Formats a protocol version.
* This method does <i>not</i> follow the general contract for
* <code>buffer</code> arguments.
* It does <i>not</i> 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
* <code>formatProtocolVersion</code>.
*
* @param buffer a buffer to which to append, or <code>null</code>
* @param version the protocol version to format
*
* @return a buffer with the formatted protocol version appended.
* The caller is allowed to modify the result buffer.
* If the <code>buffer</code> argument is not <code>null</code>,
* the returned buffer is the argument buffer.
*/
CharArrayBuffer appendProtocolVersion(CharArrayBuffer buffer,
ProtocolVersion version);
/**
* Formats a request line.
*
* @param buffer a buffer available for formatting, or
* <code>null</code>.
* The buffer will be cleared before use.
* @param reqline the request line to format
*
* @return the formatted request line
*/
CharArrayBuffer formatRequestLine(CharArrayBuffer buffer,
RequestLine reqline);
/**
* Formats a status line.
*
* @param buffer a buffer available for formatting, or
* <code>null</code>.
* The buffer will be cleared before use.
* @param statline the status line to format
*
* @return the formatted status line
*
* @throws ch.boye.httpclientandroidlib.ParseException in case of a parse error
*/
CharArrayBuffer formatStatusLine(CharArrayBuffer buffer,
StatusLine statline);
/**
* 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 <i>no</i> trailing CR-LF in the result.
* <br/>
* See the class comment for details about the buffer argument.
*
* @param buffer a buffer available for formatting, or
* <code>null</code>.
* The buffer will be cleared before use.
* @param header the header to format
*
* @return a buffer holding the formatted header, never <code>null</code>.
* The returned buffer may be different from the argument buffer.
*
* @throws ch.boye.httpclientandroidlib.ParseException in case of a parse error
*/
CharArrayBuffer formatHeader(CharArrayBuffer buffer,
Header header);
}
|
