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.Header;
33  import org.apache.http.HeaderElement;
34  import org.apache.http.ParseException;
35  import org.apache.http.annotation.ThreadingBehavior;
36  import org.apache.http.annotation.Contract;
37  import org.apache.http.util.Args;
38  
39  /**
40   * Basic implementation of {@link Header}.
41   *
42   * @since 4.0
43   */
44  @Contract(threading = ThreadingBehavior.IMMUTABLE)
45  public class BasicHeader implements Header, Cloneable, Serializable {
46  
47      private static final long serialVersionUID = -5427236326487562174L;
48  
49      private final String name;
50      private final String value;
51  
52      /**
53       * Constructor with name and value
54       *
55       * @param name the header name
56       * @param value the header value
57       */
58      public BasicHeader(final String name, final String value) {
59          super();
60          this.name = Args.notNull(name, "Name");
61          this.value = value;
62      }
63  
64      @Override
65      public String getName() {
66          return this.name;
67      }
68  
69      @Override
70      public String getValue() {
71          return this.value;
72      }
73  
74      @Override
75      public String toString() {
76          // no need for non-default formatting in toString()
77          return BasicLineFormatter.INSTANCE.formatHeader(null, this).toString();
78      }
79  
80      @Override
81      public HeaderElement[] getElements() throws ParseException {
82          if (this.value != null) {
83              // result intentionally not cached, it's probably not used again
84              return BasicHeaderValueParser.parseElements(this.value, null);
85          } else {
86              return new HeaderElement[] {};
87          }
88      }
89  
90      @Override
91      public Object clone() throws CloneNotSupportedException {
92          return super.clone();
93      }
94  
95  }