public class

BasicHeaderElement

extends Object
implements Cloneable HeaderElement
java.lang.Object
   ↳ org.apache.http.message.BasicHeaderElement

Class Overview

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.

Summary

Public Constructors
BasicHeaderElement(String name, String value, NameValuePair[] parameters)
Constructor with name, value and parameters.
BasicHeaderElement(String name, String value)
Constructor with name and value.
Public Methods
Object clone()
Creates and returns a copy of this Object.
boolean equals(Object object)
Compares this instance with the specified object and indicates if they are equal.
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 this object.
String toString()
Returns a string containing a concise, human-readable description of this object.
[Expand]
Inherited Methods
From class java.lang.Object
From interface org.apache.http.HeaderElement

Public Constructors

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

Since: API Level 1

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

public BasicHeaderElement (String name, String value)

Since: API Level 1

Constructor with name and value.

Parameters
name header element name
value header element value. May be null

Public Methods

public Object clone ()

Since: API Level 1

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.

Returns
  • a copy of this object.
Throws
CloneNotSupportedException

public boolean equals (Object object)

Since: API Level 1

Compares this instance with the specified object and indicates if they are equal. In order to be equal, o must represent the same object as this instance using a class-specific comparison. The general contract is that this comparison should be both transitive and reflexive.

The implementation in Object returns true only if o is the exact same object as the receiver (using the == operator for comparison). Subclasses often implement equals(Object) so that it takes into account the two object's types and states.

The general contract for the equals(Object) and hashCode() methods is that if equals returns true for any two objects, then hashCode() must return the same value for these objects. This means that subclasses of Object usually override either both methods or none of them.

Parameters
object the object to compare this instance with.
Returns
  • true if the specified object is equal to this Object; false otherwise.

public String getName ()

Since: API Level 1

Returns the name.

Returns
  • String name The name

public NameValuePair getParameter (int index)

Since: API Level 1

Obtains the parameter with the given index.

Parameters
index the index of the parameter, 0-based
Returns
  • the parameter with the given index

public NameValuePair getParameterByName (String name)

Since: API Level 1

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

Parameters
name The name to search by.
Returns
  • NameValuePair parameter with the given name

public int getParameterCount ()

Since: API Level 1

Obtains the number of parameters.

Returns
  • the number of parameters

public NameValuePair[] getParameters ()

Since: API Level 1

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

Returns

public String getValue ()

Since: API Level 1

Returns the value.

Returns
  • String value The current value.

public int hashCode ()

Since: API Level 1

Returns an integer hash code for this object. By contract, any two objects for which equals(Object) returns true must return the same hash code value. This means that subclasses of Object usually override both methods or neither method.

Returns
  • this object's hash code.

public String toString ()

Since: API Level 1

Returns a string containing a concise, human-readable description of this object. Subclasses are encouraged to override this method and provide an implementation that takes into account the object's type and data. The default implementation simply concatenates the class name, the '@' sign and a hexadecimal representation of the object's hashCode(), that is, it is equivalent to the following expression: 

 getClass().getName() + '@' + Integer.toHexString(hashCode())

Returns
  • a printable representation of this object.