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; 29 30 import org.apache.hc.core5.util.CharArrayBuffer; 31 32 /** 33 * An HTTP header which is already formatted. 34 * For example when headers are received, the original formatting 35 * can be preserved. This allows for the header to be sent without 36 * another formatting step. 37 * 38 * @since 4.0 39 */ 40 public interface FormattedHeader extends Header { 41 42 /** 43 * Obtains the buffer with the formatted header. 44 * The returned buffer MUST NOT be modified. 45 * 46 * @return the formatted header, in a buffer that must not be modified 47 */ 48 CharArrayBuffer getBuffer(); 49 50 /** 51 * Obtains the start of the header value in the {@link #getBuffer buffer}. 52 * By accessing the value in the buffer, creation of a temporary string 53 * can be avoided. 54 * 55 * @return index of the first character of the header value 56 * in the buffer returned by {@link #getBuffer getBuffer}. 57 */ 58 int getValuePos(); 59 60 }