View Javadoc

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.http.message;
29  
30  import java.io.Serializable;
31  
32  import org.apache.http.NameValuePair;
33  import org.apache.http.annotation.Immutable;
34  import org.apache.http.util.LangUtils;
35  
36  /**
37   * Basic implementation of {@link NameValuePair}.
38   *
39   * @since 4.0
40   */
41  @Immutable
42  public class BasicNameValuePair implements NameValuePair, Cloneable, Serializable {
43  
44      private static final long serialVersionUID = -6437800749411518984L;
45  
46      private final String name;
47      private final String value;
48  
49      /**
50       * Default Constructor taking a name and a value. The value may be null.
51       *
52       * @param name The name.
53       * @param value The value.
54       */
55      public BasicNameValuePair(final String name, final String value) {
56          super();
57          if (name == null) {
58              throw new IllegalArgumentException("Name may not be null");
59          }
60          this.name = name;
61          this.value = value;
62      }
63  
64      public String getName() {
65          return this.name;
66      }
67  
68      public String getValue() {
69          return this.value;
70      }
71  
72      @Override
73      public String toString() {
74          // don't call complex default formatting for a simple toString
75  
76          if (this.value == null) {
77              return name;
78          } else {
79              int len = this.name.length() + 1 + this.value.length();
80              StringBuilder buffer = new StringBuilder(len);
81              buffer.append(this.name);
82              buffer.append("=");
83              buffer.append(this.value);
84              return buffer.toString();
85          }
86      }
87  
88      @Override
89      public boolean equals(final Object object) {
90          if (this == object) return true;
91          if (object instanceof NameValuePair) {
92              BasicNameValuePair that = (BasicNameValuePair) object;
93              return this.name.equals(that.name)
94                    && LangUtils.equals(this.value, that.value);
95          } else {
96              return false;
97          }
98      }
99  
100     @Override
101     public int hashCode() {
102         int hash = LangUtils.HASH_SEED;
103         hash = LangUtils.hashCode(hash, this.name);
104         hash = LangUtils.hashCode(hash, this.value);
105         return hash;
106     }
107 
108     @Override
109     public Object clone() throws CloneNotSupportedException {
110         return super.clone();
111     }
112 
113 }