View Javadoc

1   /*
2    * Copyright 1999-2002,2004 The Apache Software Foundation.
3    * 
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    * 
8    *      http://www.apache.org/licenses/LICENSE-2.0
9    * 
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  
17  package org.apache.commons.latka.http;
18  
19  import java.util.List;
20  
21  /**
22   * Create a new set of parameters
23   *
24   * @author Morgan Delagrange
25   * @author <a href=mailto:dion@multitask.com.au">dIon Gillard</a>
26   * @version $Id: Parameters.java 155424 2005-02-26 13:09:29Z dirkv $
27   */
28  public interface Parameters {
29    
30    /**
31     * Add a parameter to the request
32     * 
33     * @param paramName parameter name
34     * @param paramValue parameter value, or null for an empty value
35     */
36    void addParameter(String paramName, String paramValue);
37  
38    /**
39     * Returns a list of all the parameters for the request.
40     * Elements of the list are a String array with the
41     * parameter name as the first value and the parameter value
42     * as the second (can be null).
43     * 
44     * @return all parameters for the request
45     */
46    List getParameters();
47  
48  }