|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.http.message.BasicHeaderElement
public class 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.
Constructor Summary | |
---|---|
BasicHeaderElement(java.lang.String name,
java.lang.String value)
Constructor with name and value. |
|
BasicHeaderElement(java.lang.String name,
java.lang.String value,
NameValuePair[] parameters)
Constructor with name, value and parameters. |
Method Summary | |
---|---|
java.lang.Object |
clone()
|
boolean |
equals(java.lang.Object object)
|
java.lang.String |
getName()
Returns the name. |
NameValuePair |
getParameter(int index)
Obtains the parameter with the given index. |
NameValuePair |
getParameterByName(java.lang.String name)
Returns parameter with the given name, if found. |
int |
getParameterCount()
Obtains the number of parameters. |
NameValuePair[] |
getParameters()
Get parameters, if any. |
java.lang.String |
getValue()
Returns the value. |
int |
hashCode()
|
java.lang.String |
toString()
|
Methods inherited from class java.lang.Object |
---|
finalize, getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public BasicHeaderElement(java.lang.String name, java.lang.String value, NameValuePair[] parameters)
name
- header element namevalue
- header element value. May be nullparameters
- header element parameters. May be null.
Parameters are copied by reference, not by valuepublic BasicHeaderElement(java.lang.String name, java.lang.String value)
name
- header element namevalue
- header element value. May be nullMethod Detail |
---|
public java.lang.String getName()
getName
in interface HeaderElement
public java.lang.String getValue()
getValue
in interface HeaderElement
public NameValuePair[] getParameters()
getParameters
in interface HeaderElement
NameValuePair
spublic int getParameterCount()
getParameterCount
in interface HeaderElement
public NameValuePair getParameter(int index)
getParameter
in interface HeaderElement
index
- the index of the parameter, 0-based
public NameValuePair getParameterByName(java.lang.String name)
getParameterByName
in interface HeaderElement
name
- The name to search by.
public boolean equals(java.lang.Object object)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public java.lang.String toString()
toString
in class java.lang.Object
public java.lang.Object clone() throws java.lang.CloneNotSupportedException
clone
in class java.lang.Object
java.lang.CloneNotSupportedException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |