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