1/*
2 * $HeadURL: http://svn.apache.org/repos/asf/httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/FormattedHeader.java $
3 * $Revision: 569781 $
4 * $Date: 2007-08-26 02:05:06 -0700 (Sun, 26 Aug 2007) $
5 *
6 * ====================================================================
7 * Licensed to the Apache Software Foundation (ASF) under one
8 * or more contributor license agreements.  See the NOTICE file
9 * distributed with this work for additional information
10 * regarding copyright ownership.  The ASF licenses this file
11 * to you under the Apache License, Version 2.0 (the
12 * "License"); you may not use this file except in compliance
13 * with the License.  You may obtain a copy of the License at
14 *
15 *   http://www.apache.org/licenses/LICENSE-2.0
16 *
17 * Unless required by applicable law or agreed to in writing,
18 * software distributed under the License is distributed on an
19 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
20 * KIND, either express or implied.  See the License for the
21 * specific language governing permissions and limitations
22 * under the License.
23 * ====================================================================
24 *
25 * This software consists of voluntary contributions made by many
26 * individuals on behalf of the Apache Software Foundation.  For more
27 * information on the Apache Software Foundation, please see
28 * <http://www.apache.org/>.
29 *
30 */
31
32package org.apache.http;
33
34import org.apache.http.util.CharArrayBuffer;
35
36/**
37 * An HTTP header which is already formatted.
38 * For example when headers are received, the original formatting
39 * can be preserved. This allows for the header to be sent without
40 * another formatting step.
41 *
42 *
43 * @version $Revision: 569781 $
44 */
45public interface FormattedHeader extends Header {
46
47
48    /**
49     * Obtains the buffer with the formatted header.
50     * The returned buffer MUST NOT be modified.
51     *
52     * @return  the formatted header, in a buffer that must not be modified
53     */
54    CharArrayBuffer getBuffer()
55        ;
56
57    /**
58     * Obtains the start of the header value in the {@link #getBuffer buffer}.
59     * By accessing the value in the buffer, creation of a temporary string
60     * can be avoided.
61     *
62     * @return  index of the first character of the header value
63     *          in the buffer returned by {@link #getBuffer getBuffer}.
64     */
65    int getValuePos()
66        ;
67
68}
69