org.apache.http.message
Class BasicHeader

java.lang.Object
  org.apache.http.message.BasicHeader

All Implemented Interfaces:

Header

public class BasicHeader

extends java.lang.Object

implements Header

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: 503412 $ $Date: 2007-02-04 15:14:42 +0100 (Sun, 04 Feb 2007) $

Author:

Remy Maucherat, Mike Bowler, Oleg Kalnichevski

Constructor Summary

BasicHeader(java.lang.String name, java.lang.String value)
Constructor with name and value

Method Summary

static void	format(CharArrayBuffer buffer, Header header) Formats a Header into a header line.
static java.lang.String	format(Header header)
HeaderElement[]	getElements() Returns an array of HeaderElements constructed from my value.
java.lang.String	getName() Returns the header name.
java.lang.String	getValue() Returns the header value.
java.lang.String	toString() Returns a String representation of the header.

Methods inherited from class java.lang.Object

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

Constructor Detail

BasicHeader

public BasicHeader(java.lang.String name,
                   java.lang.String value)

Constructor with name and value

Parameters:

name - the header name

value - the header value

Method Detail

getName

public java.lang.String getName()

Returns the header name.

Specified by:

getName in interface Header

Returns:

String name The name

getValue

public java.lang.String getValue()

Returns the header value.

Specified by:

getValue in interface Header

Returns:

String value The current value.

toString

public java.lang.String toString()

Returns a String representation of the header.

Returns:

a string

getElements

public HeaderElement[] getElements()

Returns an array of HeaderElements constructed from my value.

Specified by:

getElements in interface Header

Returns:

an array of header elements

See Also:

BasicHeaderElement.parseAll(org.apache.http.util.CharArrayBuffer, int, int)

format

public static void format(CharArrayBuffer buffer,
                          Header header)

Formats a Header into a header line. The header is directly appended to buffer; no newline characters are inserted (folding).

Parameters:

buffer - the buffer to append to

header - the header to format

format

public static java.lang.String format(Header header)

See Also:

format(CharArrayBuffer, Header)