Package org.apache.http.message

Class BasicHeader

java.lang.Object

org.apache.http.message.BasicHeader

All Implemented Interfaces:

Cloneable, Header

public class BasicHeader
extends Object
implements Header, Cloneable

Represents an HTTP header field.

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.

     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>

Since:

4.0

Version:

$Revision: 652956 $ $Date: 2008-05-02 17:13:05 -0700 (Fri, 02 May 2008) $

Author:

Remy Maucherat, Mike Bowler, Oleg Kalnichevski

Constructor Summary

Constructors

Constructor	Description
BasicHeader(String name, String value)	Constructor with name and value

Method Summary

Modifier and Type	Method	Description
Object	clone()	Creates and returns a copy of this Object.
HeaderElement[]	getElements()	Returns an array of HeaderElements constructed from my value.
String	getName()	Returns the header name.
String	getValue()	Returns the header value.
String	toString()	Returns a String representation of the header.

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

BasicHeader

public BasicHeader(String name, String value)

Constructor with name and value

Parameters:

name - the header name

value - the header value

Method Details

getName

public String getName()

Returns the header name.

Specified by:

getName in interface Header

Returns:

String name The name

getValue

public String getValue()

Returns the header value.

Specified by:

getValue in interface Header

Returns:

String value The current value.

toString

public String toString()

Returns a String representation of the header.

Overrides:

toString in class Object

Returns:

a string

getElements

public HeaderElement[] getElements() throws ParseException

Returns an array of HeaderElements constructed from my value.

Specified by:

getElements in interface Header

Returns:

an array of header elements

Throws:

ParseException - in case of a parse error

See Also:

BasicHeaderValueParser.parseElements(String, HeaderValueParser)

clone

public Object clone() throws CloneNotSupportedException

Description copied from class: Object

Creates and returns a copy of this Object. The default implementation returns a so-called "shallow" copy: It creates a new instance of the same class and then copies the field values (including object references) from this instance to the new instance. A "deep" copy, in contrast, would also recursively clone nested objects. A subclass that needs to implement this kind of cloning should call super.clone() to create the new instance and then create deep copies of the nested, mutable objects.

Overrides:

clone in class Object

Returns:

a copy of this object.

Throws:

CloneNotSupportedException - if this object's class does not implement the Cloneable interface.