org.apache.http.message
Class BasicHeaderElement

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

All Implemented Interfaces:

Cloneable, HeaderElement

public class BasicHeaderElement
extends Object
implements HeaderElement, Cloneable

One element of an HTTP header's value.

Some HTTP headers (such as the set-cookie header) have values that can be decomposed into multiple elements. Such headers must be in the following form:

 header  = [ element ] *( "," [ element ] )
 element = name [ "=" [ value ] ] *( ";" [ param ] )
 param   = name [ "=" [ value ] ]

 name    = token
 value   = ( token | quoted-string )

 token         = 1*<any char except "=", ",", ";", <"> and
                       white space>
 quoted-string = <"> *( text | quoted-char ) <">
 text          = any char except <">
 quoted-char   = "\" char
 

Any amount of white space is allowed between any part of the header, element or param and is ignored. A missing value in any element or param will be stored as the empty String; if the "=" is also missing null will be stored instead.

This class represents an individual header element, containing both a name/value pair (value may be null) and optionally a set of additional parameters.

Since:

4.0

Constructor Summary

BasicHeaderElement(String name, String value)
Constructor with name and value.

BasicHeaderElement(String name, String value, NameValuePair[] parameters)
Constructor with name, value and parameters.

Method Summary

Object	clone() Returns a new instance of the same class as the receiver, whose slots have been filled in with the values in the slots of the receiver.
boolean	equals(Object object) Compares the argument to the receiver, and returns true if they represent the same object using a class specific comparison.
String	getName() Returns the name.
NameValuePair	getParameter(int index) Obtains the parameter with the given index.
NameValuePair	getParameterByName(String name) Returns parameter with the given name, if found.
int	getParameterCount() Obtains the number of parameters.
NameValuePair[]	getParameters() Get parameters, if any.
String	getValue() Returns the value.
int	hashCode() Returns an integer hash code for the receiver.
String	toString() Returns a string containing a concise, human-readable description of the receiver.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

BasicHeaderElement

public BasicHeaderElement(String name,
                          String value,
                          NameValuePair[] parameters)

Constructor with name, value and parameters.

Parameters:

name - header element name

value - header element value. May be null

parameters - header element parameters. May be null. Parameters are copied by reference, not by value

BasicHeaderElement

public BasicHeaderElement(String name,
                          String value)

Constructor with name and value.

Parameters:

name - header element name

value - header element value. May be null

Method Detail

getName

public String getName()

Returns the name.

Specified by:

getName in interface HeaderElement

Returns:

String name The name

getValue

public String getValue()

Returns the value.

Specified by:

getValue in interface HeaderElement

Returns:

String value The current value.

getParameters

public NameValuePair[] getParameters()

Get parameters, if any. The returned array is created for each invocation and can be modified by the caller without affecting this header element.

Specified by:

getParameters in interface HeaderElement

Returns:

parameters as an array of NameValuePairs

getParameterCount

public int getParameterCount()

Obtains the number of parameters.

Specified by:

getParameterCount in interface HeaderElement

Returns:

the number of parameters

getParameter

public NameValuePair getParameter(int index)

Obtains the parameter with the given index.

Specified by:

getParameter in interface HeaderElement

Parameters:

index - the index of the parameter, 0-based

Returns:

the parameter with the given index

getParameterByName

public NameValuePair getParameterByName(String name)

Returns parameter with the given name, if found. Otherwise null is returned

Specified by:

getParameterByName in interface HeaderElement

Parameters:

name - The name to search by.

Returns:

NameValuePair parameter with the given name

equals

public boolean equals(Object object)

Description copied from class: Object

Compares the argument to the receiver, and returns true if they represent the same object using a class specific comparison. The implementation in Object returns true only if the argument is the exact same object as the receiver (==).

Overrides:

equals in class Object

Parameters:

object - Object the object to compare with this object.

Returns:

boolean true if the object is the same as this object false if it is different from this object.

See Also:

Object.hashCode()

hashCode

public int hashCode()

Description copied from class: Object

Returns an integer hash code for the receiver. Any two objects which answer true when passed to .equals must answer the same value for this method.

Overrides:

hashCode in class Object

Returns:

int the receiver's hash.

See Also:

Object.equals(java.lang.Object)

toString

public String toString()

Description copied from class: Object

Returns a string containing a concise, human-readable description of the receiver.

Overrides:

toString in class Object

Returns:

String a printable representation for the receiver.

clone

public Object clone()
             throws CloneNotSupportedException

Description copied from class: Object

Returns a new instance of the same class as the receiver, whose slots have been filled in with the values in the slots of the receiver.

Classes which wish to support cloning must specify that they implement the Cloneable interface, since the implementation checks for this.

Overrides:

clone in class Object

Returns:

Object a shallow copy of this object.

Throws:

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