1069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project/* 2069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * $HeadURL: http://svn.apache.org/repos/asf/httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/message/HeaderValueFormatter.java $ 3069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * $Revision: 571954 $ 4069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * $Date: 2007-09-02 04:05:21 -0700 (Sun, 02 Sep 2007) $ 5069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 6069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * ==================================================================== 7069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Licensed to the Apache Software Foundation (ASF) under one 8069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * or more contributor license agreements. See the NOTICE file 9069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * distributed with this work for additional information 10069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * regarding copyright ownership. The ASF licenses this file 11069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * to you under the Apache License, Version 2.0 (the 12069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * "License"); you may not use this file except in compliance 13069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * with the License. You may obtain a copy of the License at 14069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 15069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * http://www.apache.org/licenses/LICENSE-2.0 16069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 17069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Unless required by applicable law or agreed to in writing, 18069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * software distributed under the License is distributed on an 19069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 20069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * KIND, either express or implied. See the License for the 21069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * specific language governing permissions and limitations 22069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * under the License. 23069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * ==================================================================== 24069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 25069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * This software consists of voluntary contributions made by many 26069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * individuals on behalf of the Apache Software Foundation. For more 27069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * information on the Apache Software Foundation, please see 28069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * <http://www.apache.org/>. 29069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 30069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 31069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 32069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectpackage org.apache.http.message; 33069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 34069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 35069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectimport org.apache.http.HeaderElement; 36069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectimport org.apache.http.NameValuePair; 37069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectimport org.apache.http.util.CharArrayBuffer; 38069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 39069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 40069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 41069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project/** 42069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Interface for formatting elements of a header value. 43069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * This is the complement to {@link HeaderValueParser}. 44069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Instances of this interface are expected to be stateless and thread-safe. 45069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 46069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * <p> 47069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * All formatting methods accept an optional buffer argument. 48069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * If a buffer is passed in, the formatted element will be appended 49069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * and the modified buffer is returned. If no buffer is passed in, 50069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * a new buffer will be created and filled with the formatted element. 51069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * In both cases, the caller is allowed to modify the returned buffer. 52069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * </p> 53069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 54069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 55069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * <!-- empty lines above to avoid 'svn diff' context problems --> 56069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @version $Revision: 571954 $ 57069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 58069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @since 4.0 59d42abb2fd917184764daf22f5f299e848b8701d7Narayan Kamath * 60d42abb2fd917184764daf22f5f299e848b8701d7Narayan Kamath * @deprecated Please use {@link java.net.URL#openConnection} instead. 61d42abb2fd917184764daf22f5f299e848b8701d7Narayan Kamath * Please visit <a href="http://android-developers.blogspot.com/2011/09/androids-http-clients.html">this webpage</a> 62d42abb2fd917184764daf22f5f299e848b8701d7Narayan Kamath * for further details. 63069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 64d42abb2fd917184764daf22f5f299e848b8701d7Narayan Kamath@Deprecated 65069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectpublic interface HeaderValueFormatter { 66069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 67069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** 68069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Formats an array of header elements. 69069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 70069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @param buffer the buffer to append to, or 71069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * <code>null</code> to create a new buffer 72069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @param elems the header elements to format 73069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @param quote <code>true</code> to always format with quoted values, 74069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * <code>false</code> to use quotes only when necessary 75069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 76069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @return a buffer with the formatted header elements. 77069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * If the <code>buffer</code> argument was not <code>null</code>, 78069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * that buffer will be used and returned. 79069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 80069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project CharArrayBuffer formatElements(CharArrayBuffer buffer, 81069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project HeaderElement[] elems, 82069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project boolean quote) 83069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project ; 84069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 85069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 86069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** 87069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Formats one header element. 88069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 89069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @param buffer the buffer to append to, or 90069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * <code>null</code> to create a new buffer 91069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @param elem the header element to format 92069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @param quote <code>true</code> to always format with quoted values, 93069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * <code>false</code> to use quotes only when necessary 94069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 95069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @return a buffer with the formatted header element. 96069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * If the <code>buffer</code> argument was not <code>null</code>, 97069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * that buffer will be used and returned. 98069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 99069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project CharArrayBuffer formatHeaderElement(CharArrayBuffer buffer, 100069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project HeaderElement elem, 101069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project boolean quote) 102069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project ; 103069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 104069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 105069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 106069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** 107069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Formats the parameters of a header element. 108069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * That's a list of name-value pairs, to be separated by semicolons. 109069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * This method will <i>not</i> generate a leading semicolon. 110069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 111069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @param buffer the buffer to append to, or 112069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * <code>null</code> to create a new buffer 113069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @param nvps the parameters (name-value pairs) to format 114069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @param quote <code>true</code> to always format with quoted values, 115069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * <code>false</code> to use quotes only when necessary 116069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 117069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @return a buffer with the formatted parameters. 118069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * If the <code>buffer</code> argument was not <code>null</code>, 119069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * that buffer will be used and returned. 120069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 121069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project CharArrayBuffer formatParameters(CharArrayBuffer buffer, 122069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project NameValuePair[] nvps, 123069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project boolean quote) 124069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project ; 125069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 126069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 127069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** 128069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Formats one name-value pair, where the value is optional. 129069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 130069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @param buffer the buffer to append to, or 131069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * <code>null</code> to create a new buffer 132069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @param nvp the name-value pair to format 133069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @param quote <code>true</code> to always format with a quoted value, 134069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * <code>false</code> to use quotes only when necessary 135069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 136069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @return a buffer with the formatted name-value pair. 137069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * If the <code>buffer</code> argument was not <code>null</code>, 138069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * that buffer will be used and returned. 139069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 140069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project CharArrayBuffer formatNameValuePair(CharArrayBuffer buffer, 141069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project NameValuePair nvp, 142069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project boolean quote) 143069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project ; 144069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 145069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project} 146069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 147