1 /*
2 * ====================================================================
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements. See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership. The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License. You may obtain a copy of the License at
10 *
11 * http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied. See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 * ====================================================================
20 *
21 * This software consists of voluntary contributions made by many
22 * individuals on behalf of the Apache Software Foundation. For more
23 * information on the Apache Software Foundation, please see
24 * <http://www.apache.org/>.
25 *
26 */
27
28 package org.apache.hc.core5.http.message;
29
30 import org.apache.hc.core5.http.Header;
31 import org.apache.hc.core5.util.CharArrayBuffer;
32
33 /**
34 * Interface for formatting elements of the HEAD section of an HTTP message.
35 * There are individual methods for formatting a request line, a
36 * status line, or a header line. The formatting methods are expected to produce
37 * one line of formatted content that does <i>not</i> include a line delimiter
38 * (such as CR-LF). Instances of this interface are expected to be stateless and
39 * thread-safe.
40 *
41 * @since 4.0
42 */
43 public interface LineFormatter {
44
45 /**
46 * Formats a request line.
47 *
48 * @param buffer buffer to write formatted content to.
49 * @param reqline the request line to format
50 */
51 void formatRequestLine(CharArrayBuffer buffer, RequestLine reqline);
52
53 /**
54 * Formats a status line.
55 *
56 * @param buffer buffer to write formatted content to.
57 * @param statline the status line to format
58 */
59 void formatStatusLine(CharArrayBuffer buffer, StatusLine statline);
60
61 /**
62 * Formats a header.
63 *
64 * @param buffer buffer to write formatted content to.
65 * @param header the header to format
66 */
67 void formatHeader(CharArrayBuffer buffer, Header header);
68
69 }