| java.lang.Object | |
| ↳ | 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.
| Public Constructors | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
Constructor with name, value and parameters.
| |||||||||||
Constructor with name and value.
| |||||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
Creates and returns a copy of this
Object. | |||||||||||
Compares this instance with the specified object and indicates if they
are equal.
| |||||||||||
Returns the name.
| |||||||||||
Obtains the parameter with the given index.
| |||||||||||
Returns parameter with the given name, if found.
| |||||||||||
Obtains the number of parameters.
| |||||||||||
Get parameters, if any.
| |||||||||||
Returns the value.
| |||||||||||
Returns an integer hash code for this object.
| |||||||||||
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
| |||||||||||
Constructor with name, value and 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 |
Constructor with name and value.
| name | header element name |
|---|---|
| value | header element value. May be null |
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.
| CloneNotSupportedException |
|---|
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 reflexive, symmetric, and transitive.
Also, no object reference other than null is equal to null.
The default implementation returns true only if this ==
o. See Writing a correct
equals method
if you intend implementing your own equals method.
The general contract for the equals 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 neither of them.
| object | the object to compare this instance with. |
|---|
true if the specified object is equal to this Object; false otherwise.Obtains the parameter with the given index.
| index | the index of the parameter, 0-based |
|---|
Returns parameter with the given name, if found. Otherwise null is returned
| name | The name to search by. |
|---|
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.
NameValuePairs
Returns the value.
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.
Note that hash values must not change over time unless information used in equals comparisons also changes.
See Writing a correct
hashCode method
if you intend implementing your own hashCode method.
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 is equivalent to the following expression:
getClass().getName() + '@' + Integer.toHexString(hashCode())
See Writing a useful
toString method
if you intend implementing your own toString method.