org.apache.http.message.BasicHeaderElement
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
Public Methods
clone,
equals,
finalize,
getClass,
hashCode,
notify,
notifyAll,
toString,
wait,
wait,
wait
Details
Public Constructors
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)
Constructor with name and value.
Parameters
name
| header element name |
value
| header element value. May be null
|
Public Methods
public
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.
Classes which wish to support cloning must specify that they implement
the Cloneable interface, since the implementation checks for this.
Returns
- Object a shallow copy of this object.
public
boolean
equals(Object 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 (==).
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.
public
NameValuePair
getParameter(int index)
Obtains the parameter with the given index.
Parameters
index
| the index of the parameter, 0-based |
Returns
- the parameter with the given index
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()
Obtains the number of parameters.
Get parameters, if any.
The returned array is created for each invocation and can
be modified by the caller without affecting this header element.
public
String
getValue()
Returns the value.
Returns
- String value The current value.
public
int
hashCode()
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.
public
String
toString()
Returns a string containing a concise, human-readable description of the
receiver.
Returns
- String a printable representation for the receiver.