michael@0: /*
michael@0:  * ====================================================================
michael@0:  * Licensed to the Apache Software Foundation (ASF) under one
michael@0:  * or more contributor license agreements.  See the NOTICE file
michael@0:  * distributed with this work for additional information
michael@0:  * regarding copyright ownership.  The ASF licenses this file
michael@0:  * to you under the Apache License, Version 2.0 (the
michael@0:  * "License"); you may not use this file except in compliance
michael@0:  * with the License.  You may obtain a copy of the License at
michael@0:  *
michael@0:  *   http://www.apache.org/licenses/LICENSE-2.0
michael@0:  *
michael@0:  * Unless required by applicable law or agreed to in writing,
michael@0:  * software distributed under the License is distributed on an
michael@0:  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
michael@0:  * KIND, either express or implied.  See the License for the
michael@0:  * specific language governing permissions and limitations
michael@0:  * under the License.
michael@0:  * ====================================================================
michael@0:  *
michael@0:  * This software consists of voluntary contributions made by many
michael@0:  * individuals on behalf of the Apache Software Foundation.  For more
michael@0:  * information on the Apache Software Foundation, please see
michael@0:  * <http://www.apache.org/>.
michael@0:  *
michael@0:  */
michael@0: 
michael@0: package ch.boye.httpclientandroidlib;
michael@0: 
michael@0: import ch.boye.httpclientandroidlib.util.CharArrayBuffer;
michael@0: 
michael@0: /**
michael@0:  * An HTTP header which is already formatted.
michael@0:  * For example when headers are received, the original formatting
michael@0:  * can be preserved. This allows for the header to be sent without
michael@0:  * another formatting step.
michael@0:  *
michael@0:  * @since 4.0
michael@0:  */
michael@0: public interface FormattedHeader extends Header {
michael@0: 
michael@0:     /**
michael@0:      * Obtains the buffer with the formatted header.
michael@0:      * The returned buffer MUST NOT be modified.
michael@0:      *
michael@0:      * @return  the formatted header, in a buffer that must not be modified
michael@0:      */
michael@0:     CharArrayBuffer getBuffer();
michael@0: 
michael@0:     /**
michael@0:      * Obtains the start of the header value in the {@link #getBuffer buffer}.
michael@0:      * By accessing the value in the buffer, creation of a temporary string
michael@0:      * can be avoided.
michael@0:      *
michael@0:      * @return  index of the first character of the header value
michael@0:      *          in the buffer returned by {@link #getBuffer getBuffer}.
michael@0:      */
michael@0:     int getValuePos();
michael@0: 
michael@0: }