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 /** 31 * Represents an element of an HTTP {@link Header header} value consisting of 32 * a name / value pair and a number of optional name / value parameters. 33 * 34 * @since 4.0 35 */ 36 public interface HeaderElement { 37 38 /** 39 * Returns header element name. 40 * 41 * @return header element name 42 */ 43 String getName(); 44 45 /** 46 * Returns header element value. 47 * 48 * @return header element value 49 */ 50 String getValue(); 51 52 /** 53 * Returns an array of name / value pairs. 54 * 55 * @return array of name / value pairs 56 */ 57 NameValuePair[] getParameters(); 58 59 /** 60 * Returns the first parameter with the given name. 61 * 62 * @param name parameter name 63 * 64 * @return name / value pair 65 */ 66 NameValuePair getParameterByName(String name); 67 68 /** 69 * Returns the total count of parameters. 70 * 71 * @return parameter count 72 */ 73 int getParameterCount(); 74 75 /** 76 * Returns parameter with the given index. 77 * 78 * @param index index 79 * @return name / value pair 80 */ 81 NameValuePair getParameter(int index); 82 83 } 84