001/*
002 * ====================================================================
003 * Licensed to the Apache Software Foundation (ASF) under one
004 * or more contributor license agreements.  See the NOTICE file
005 * distributed with this work for additional information
006 * regarding copyright ownership.  The ASF licenses this file
007 * to you under the Apache License, Version 2.0 (the
008 * "License"); you may not use this file except in compliance
009 * with the License.  You may obtain a copy of the License at
010 *
011 *   http://www.apache.org/licenses/LICENSE-2.0
012 *
013 * Unless required by applicable law or agreed to in writing,
014 * software distributed under the License is distributed on an
015 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
016 * KIND, either express or implied.  See the License for the
017 * specific language governing permissions and limitations
018 * under the License.
019 * ====================================================================
020 *
021 * This software consists of voluntary contributions made by many
022 * individuals on behalf of the Apache Software Foundation.  For more
023 * information on the Apache Software Foundation, please see
024 * <http://www.apache.org/>.
025 *
026 */
027
028package org.apache.http.message;
029
030import java.io.Serializable;
031
032import org.apache.http.Header;
033import org.apache.http.HeaderElement;
034import org.apache.http.ParseException;
035import org.apache.http.annotation.ThreadingBehavior;
036import org.apache.http.annotation.Contract;
037import org.apache.http.util.Args;
038
039/**
040 * Basic implementation of {@link Header}.
041 *
042 * @since 4.0
043 */
044@Contract(threading = ThreadingBehavior.IMMUTABLE)
045public class BasicHeader implements Header, Cloneable, Serializable {
046
047    private static final long serialVersionUID = -5427236326487562174L;
048
049    private final String name;
050    private final String value;
051
052    /**
053     * Constructor with name and value
054     *
055     * @param name the header name
056     * @param value the header value
057     */
058    public BasicHeader(final String name, final String value) {
059        super();
060        this.name = Args.notNull(name, "Name");
061        this.value = value;
062    }
063
064    @Override
065    public String getName() {
066        return this.name;
067    }
068
069    @Override
070    public String getValue() {
071        return this.value;
072    }
073
074    @Override
075    public String toString() {
076        // no need for non-default formatting in toString()
077        return BasicLineFormatter.INSTANCE.formatHeader(null, this).toString();
078    }
079
080    @Override
081    public HeaderElement[] getElements() throws ParseException {
082        if (this.value != null) {
083            // result intentionally not cached, it's probably not used again
084            return BasicHeaderValueParser.parseElements(this.value, null);
085        } else {
086            return new HeaderElement[] {};
087        }
088    }
089
090    @Override
091    public Object clone() throws CloneNotSupportedException {
092        return super.clone();
093    }
094
095}