mobile/android/thirdparty/ch/boye/httpclientandroidlib/HeaderElement.java@fc2d59ddac77 (annotated)
mobile/android/thirdparty/ch/boye/httpclientandroidlib/HeaderElement.java
Wed, 31 Dec 2014 07:22:50 +0100
- author
- Michael Schloh von Bennewitz <michael@schloh.com>
- date
- Wed, 31 Dec 2014 07:22:50 +0100
- branch
- TOR_BUG_3246
- changeset 4
- fc2d59ddac77
- permissions
- -rw-r--r--
Correct previous dual key logic pending first delivery installment.
| michael@0 | 1 | /* |
| michael@0 | 2 | * ==================================================================== |
| michael@0 | 3 | * Licensed to the Apache Software Foundation (ASF) under one |
| michael@0 | 4 | * or more contributor license agreements. See the NOTICE file |
| michael@0 | 5 | * distributed with this work for additional information |
| michael@0 | 6 | * regarding copyright ownership. The ASF licenses this file |
| michael@0 | 7 | * to you under the Apache License, Version 2.0 (the |
| michael@0 | 8 | * "License"); you may not use this file except in compliance |
| michael@0 | 9 | * with the License. You may obtain a copy of the License at |
| michael@0 | 10 | * |
| michael@0 | 11 | * http://www.apache.org/licenses/LICENSE-2.0 |
| michael@0 | 12 | * |
| michael@0 | 13 | * Unless required by applicable law or agreed to in writing, |
| michael@0 | 14 | * software distributed under the License is distributed on an |
| michael@0 | 15 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| michael@0 | 16 | * KIND, either express or implied. See the License for the |
| michael@0 | 17 | * specific language governing permissions and limitations |
| michael@0 | 18 | * under the License. |
| michael@0 | 19 | * ==================================================================== |
| michael@0 | 20 | * |
| michael@0 | 21 | * This software consists of voluntary contributions made by many |
| michael@0 | 22 | * individuals on behalf of the Apache Software Foundation. For more |
| michael@0 | 23 | * information on the Apache Software Foundation, please see |
| michael@0 | 24 | * <http://www.apache.org/>. |
| michael@0 | 25 | * |
| michael@0 | 26 | */ |
| michael@0 | 27 | |
| michael@0 | 28 | package ch.boye.httpclientandroidlib; |
| michael@0 | 29 | |
| michael@0 | 30 | /** |
| michael@0 | 31 | * One element of an HTTP {@link Header header} value consisting of |
| michael@0 | 32 | * a name / value pair and a number of optional name / value parameters. |
| michael@0 | 33 | * <p> |
| michael@0 | 34 | * Some HTTP headers (such as the set-cookie header) have values that |
| michael@0 | 35 | * can be decomposed into multiple elements. Such headers must be in the |
| michael@0 | 36 | * following form: |
| michael@0 | 37 | * </p> |
| michael@0 | 38 | * <pre> |
| michael@0 | 39 | * header = [ element ] *( "," [ element ] ) |
| michael@0 | 40 | * element = name [ "=" [ value ] ] *( ";" [ param ] ) |
| michael@0 | 41 | * param = name [ "=" [ value ] ] |
| michael@0 | 42 | * |
| michael@0 | 43 | * name = token |
| michael@0 | 44 | * value = ( token | quoted-string ) |
| michael@0 | 45 | * |
| michael@0 | 46 | * token = 1*<any char except "=", ",", ";", <"> and |
| michael@0 | 47 | * white space> |
| michael@0 | 48 | * quoted-string = <"> *( text | quoted-char ) <"> |
| michael@0 | 49 | * text = any char except <"> |
| michael@0 | 50 | * quoted-char = "\" char |
| michael@0 | 51 | * </pre> |
| michael@0 | 52 | * <p> |
| michael@0 | 53 | * Any amount of white space is allowed between any part of the |
| michael@0 | 54 | * header, element or param and is ignored. A missing value in any |
| michael@0 | 55 | * element or param will be stored as the empty {@link String}; |
| michael@0 | 56 | * if the "=" is also missing <var>null</var> will be stored instead. |
| michael@0 | 57 | * |
| michael@0 | 58 | * @since 4.0 |
| michael@0 | 59 | */ |
| michael@0 | 60 | public interface HeaderElement { |
| michael@0 | 61 | |
| michael@0 | 62 | /** |
| michael@0 | 63 | * Returns header element name. |
| michael@0 | 64 | * |
| michael@0 | 65 | * @return header element name |
| michael@0 | 66 | */ |
| michael@0 | 67 | String getName(); |
| michael@0 | 68 | |
| michael@0 | 69 | /** |
| michael@0 | 70 | * Returns header element value. |
| michael@0 | 71 | * |
| michael@0 | 72 | * @return header element value |
| michael@0 | 73 | */ |
| michael@0 | 74 | String getValue(); |
| michael@0 | 75 | |
| michael@0 | 76 | /** |
| michael@0 | 77 | * Returns an array of name / value pairs. |
| michael@0 | 78 | * |
| michael@0 | 79 | * @return array of name / value pairs |
| michael@0 | 80 | */ |
| michael@0 | 81 | NameValuePair[] getParameters(); |
| michael@0 | 82 | |
| michael@0 | 83 | /** |
| michael@0 | 84 | * Returns the first parameter with the given name. |
| michael@0 | 85 | * |
| michael@0 | 86 | * @param name parameter name |
| michael@0 | 87 | * |
| michael@0 | 88 | * @return name / value pair |
| michael@0 | 89 | */ |
| michael@0 | 90 | NameValuePair getParameterByName(String name); |
| michael@0 | 91 | |
| michael@0 | 92 | /** |
| michael@0 | 93 | * Returns the total count of parameters. |
| michael@0 | 94 | * |
| michael@0 | 95 | * @return parameter count |
| michael@0 | 96 | */ |
| michael@0 | 97 | int getParameterCount(); |
| michael@0 | 98 | |
| michael@0 | 99 | /** |
| michael@0 | 100 | * Returns parameter with the given index. |
| michael@0 | 101 | * |
| michael@0 | 102 | * @param index |
| michael@0 | 103 | * @return name / value pair |
| michael@0 | 104 | */ |
| michael@0 | 105 | NameValuePair getParameter(int index); |
| michael@0 | 106 | |
| michael@0 | 107 | } |
| michael@0 | 108 |
