/*
* $HeadURL: http://svn.apache.org/repos/asf/httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/message/BasicHeader.java $
* $Revision: 652956 $
* $Date: 2008-05-02 17:13:05 -0700 (Fri, 02 May 2008) $
*
* ====================================================================
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
* ====================================================================
*
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation. For more
* information on the Apache Software Foundation, please see
* <http://www.apache.org/>.
*
*/
package org.apache.http.message;
import org.apache.http.Header;
import org.apache.http.HeaderElement;
import org.apache.http.ParseException;
/**
* Represents an HTTP header field.
*
* <p>The HTTP header fields follow the same generic format as
* that given in Section 3.1 of RFC 822. Each header field consists
* of a name followed by a colon (":") and the field value. Field names
* are case-insensitive. The field value MAY be preceded by any amount
* of LWS, though a single SP is preferred.
*
*<pre>
* message-header = field-name ":" [ field-value ]
* field-name = token
* field-value = *( field-content | LWS )
* field-content = <the OCTETs making up the field-value
* and consisting of either *TEXT or combinations
* of token, separators, and quoted-string>
*</pre>
*
* @author <a href="mailto:remm@apache.org">Remy Maucherat</a>
* @author <a href="mailto:mbowler@GargoyleSoftware.com">Mike Bowler</a>
* @author <a href="mailto:oleg at ural.ru">Oleg Kalnichevski</a>
*
*
* <!-- empty lines above to avoid 'svn diff' context problems -->
* @version $Revision: 652956 $ $Date: 2008-05-02 17:13:05 -0700 (Fri, 02 May 2008) $
*
* @since 4.0
*/
public class BasicHeader implements Header, Cloneable {
/**
* Header name.
*/
private final String name;
/**
* Header value.
*/
private final String value;
/**
* Constructor with name and value
*
* @param name the header name
* @param value the header value
*/
public BasicHeader(final String name, final String value) {
super();
if (name == null) {
throw new IllegalArgumentException("Name may not be null");
}
this.name = name;
this.value = value;
}
/**
* Returns the header name.
*
* @return String name The name
*/
public String getName() {
return this.name;
}
/**
* Returns the header value.
*
* @return String value The current value.
*/
public String getValue() {
return this.value;
}
/**
* Returns a {@link String} representation of the header.
*
* @return a string
*/
public String toString() {
// no need for non-default formatting in toString()
return BasicLineFormatter.DEFAULT.formatHeader(null, this).toString();
}
/**
* Returns an array of {@link HeaderElement}s constructed from my value.
*
* @see BasicHeaderValueParser#parseElements(String, HeaderValueParser)
*
* @return an array of header elements
*
* @throws ParseException in case of a parse error
*/
public HeaderElement[] getElements() throws ParseException {
if (this.value != null) {
// result intentionally not cached, it's probably not used again
return BasicHeaderValueParser.parseElements(this.value, null);
} else {
return new HeaderElement[] {};
}
}
public Object clone() throws CloneNotSupportedException {
return super.clone();
}
}