View Javadoc

1   package org.apache.turbine.util.uri;
2   
3   /*
4    * Licensed to the Apache Software Foundation (ASF) under one
5    * or more contributor license agreements.  See the NOTICE file
6    * distributed with this work for additional information
7    * regarding copyright ownership.  The ASF licenses this file
8    * to you under the Apache License, Version 2.0 (the
9    * "License"); you may not use this file except in compliance
10   * with the License.  You may obtain a copy of the License at
11   *
12   *   http://www.apache.org/licenses/LICENSE-2.0
13   *
14   * Unless required by applicable law or agreed to in writing,
15   * software distributed under the License is distributed on an
16   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17   * KIND, either express or implied.  See the License for the
18   * specific language governing permissions and limitations
19   * under the License.
20   */
21  
22  import org.apache.commons.lang.StringUtils;
23  
24  /***
25   * Helper Class to keep a key and a value together in
26   * one object. Used for URI Parameters
27   *
28   * @author <a href="mailto:hps@intermeta.de">Henning P. Schmiedehausen</a>
29   * @version $Id: URIParam.java 534527 2007-05-02 16:10:59Z tv $
30   */
31  
32  public class URIParam
33  {
34      /*** Key */
35      private String key = null;
36  
37      /*** Value */
38      private Object value = null;
39  
40      /***
41       * Creates a new Object from Key and Value
42       *
43       * @param key A String with the Param Name.
44       * @param value An Object with the Value.
45       *
46       */
47      public URIParam(String key, Object value)
48      {
49          this.key = key;
50          this.value = value;
51      }
52  
53      /***
54       * Returns the key.
55       *
56       * @return The key value.
57       *
58       */
59      public String getKey()
60      {
61          return (StringUtils.isNotEmpty(key)) ? key : "";
62      }
63  
64      /***
65       * Returns the value.
66       *
67       * @return The value of this object.
68       *
69       */
70      public Object getValue()
71      {
72          return value;
73      }
74  }