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