mobile/android/thirdparty/ch/boye/httpclientandroidlib/HeaderElement.java

changeset 0
6474c204b198
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/mobile/android/thirdparty/ch/boye/httpclientandroidlib/HeaderElement.java	Wed Dec 31 06:09:35 2014 +0100
     1.3 @@ -0,0 +1,108 @@
     1.4 +/*
     1.5 + * ====================================================================
     1.6 + * Licensed to the Apache Software Foundation (ASF) under one
     1.7 + * or more contributor license agreements.  See the NOTICE file
     1.8 + * distributed with this work for additional information
     1.9 + * regarding copyright ownership.  The ASF licenses this file
    1.10 + * to you under the Apache License, Version 2.0 (the
    1.11 + * "License"); you may not use this file except in compliance
    1.12 + * with the License.  You may obtain a copy of the License at
    1.13 + *
    1.14 + *   http://www.apache.org/licenses/LICENSE-2.0
    1.15 + *
    1.16 + * Unless required by applicable law or agreed to in writing,
    1.17 + * software distributed under the License is distributed on an
    1.18 + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
    1.19 + * KIND, either express or implied.  See the License for the
    1.20 + * specific language governing permissions and limitations
    1.21 + * under the License.
    1.22 + * ====================================================================
    1.23 + *
    1.24 + * This software consists of voluntary contributions made by many
    1.25 + * individuals on behalf of the Apache Software Foundation.  For more
    1.26 + * information on the Apache Software Foundation, please see
    1.27 + * <http://www.apache.org/>.
    1.28 + *
    1.29 + */
    1.30 +
    1.31 +package ch.boye.httpclientandroidlib;
    1.32 +
    1.33 +/**
    1.34 + * One element of an HTTP {@link Header header} value consisting of
    1.35 + * a name / value pair and a number of optional name / value parameters.
    1.36 + * <p>
    1.37 + * Some HTTP headers (such as the set-cookie header) have values that
    1.38 + * can be decomposed into multiple elements.  Such headers must be in the
    1.39 + * following form:
    1.40 + * </p>
    1.41 + * <pre>
    1.42 + * header  = [ element ] *( "," [ element ] )
    1.43 + * element = name [ "=" [ value ] ] *( ";" [ param ] )
    1.44 + * param   = name [ "=" [ value ] ]
    1.45 + *
    1.46 + * name    = token
    1.47 + * value   = ( token | quoted-string )
    1.48 + *
    1.49 + * token         = 1*&lt;any char except "=", ",", ";", &lt;"&gt; and
    1.50 + *                       white space&gt;
    1.51 + * quoted-string = &lt;"&gt; *( text | quoted-char ) &lt;"&gt;
    1.52 + * text          = any char except &lt;"&gt;
    1.53 + * quoted-char   = "\" char
    1.54 + * </pre>
    1.55 + * <p>
    1.56 + * Any amount of white space is allowed between any part of the
    1.57 + * header, element or param and is ignored. A missing value in any
    1.58 + * element or param will be stored as the empty {@link String};
    1.59 + * if the "=" is also missing <var>null</var> will be stored instead.
    1.60 + *
    1.61 + * @since 4.0
    1.62 + */
    1.63 +public interface HeaderElement {
    1.64 +
    1.65 +    /**
    1.66 +     * Returns header element name.
    1.67 +     *
    1.68 +     * @return header element name
    1.69 +     */
    1.70 +    String getName();
    1.71 +
    1.72 +    /**
    1.73 +     * Returns header element value.
    1.74 +     *
    1.75 +     * @return header element value
    1.76 +     */
    1.77 +    String getValue();
    1.78 +
    1.79 +    /**
    1.80 +     * Returns an array of name / value pairs.
    1.81 +     *
    1.82 +     * @return array of name / value pairs
    1.83 +     */
    1.84 +    NameValuePair[] getParameters();
    1.85 +
    1.86 +    /**
    1.87 +     * Returns the first parameter with the given name.
    1.88 +     *
    1.89 +     * @param name parameter name
    1.90 +     *
    1.91 +     * @return name / value pair
    1.92 +     */
    1.93 +    NameValuePair getParameterByName(String name);
    1.94 +
    1.95 +    /**
    1.96 +     * Returns the total count of parameters.
    1.97 +     *
    1.98 +     * @return parameter count
    1.99 +     */
   1.100 +    int getParameterCount();
   1.101 +
   1.102 +    /**
   1.103 +     * Returns parameter with the given index.
   1.104 +     *
   1.105 +     * @param index
   1.106 +     * @return name / value pair
   1.107 +     */
   1.108 +    NameValuePair getParameter(int index);
   1.109 +
   1.110 +}
   1.111 +

mercurial