|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.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.
This class also exposes a parse(org.apache.http.util.CharArrayBuffer, int, int)
method for parsing a
Header
value into an array of elements.
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 | |
boolean |
equals(java.lang.Object object)
|
static void |
format(CharArrayBuffer buffer,
HeaderElement element)
|
static java.lang.String |
format(HeaderElement element)
|
static void |
formatAll(CharArrayBuffer buffer,
HeaderElement[] elements)
|
static java.lang.String |
formatAll(HeaderElement[] elements)
|
java.lang.String |
getName()
Returns the name. |
NameValuePair |
getParameterByName(java.lang.String name)
Returns parameter with the given name, if found. |
NameValuePair[] |
getParameters()
Get parameters, if any. |
java.lang.String |
getValue()
Returns the value. |
int |
hashCode()
|
static HeaderElement |
parse(CharArrayBuffer buffer,
int indexFrom,
int indexTo)
|
static HeaderElement |
parse(java.lang.String s)
|
static HeaderElement[] |
parseAll(CharArrayBuffer buffer,
int indexFrom,
int indexTo)
This parses the value part of a header. |
static HeaderElement[] |
parseAll(java.lang.String s)
This parses the value part of a header. |
java.lang.String |
toString()
|
Methods inherited from class java.lang.Object |
clone, 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 nullpublic 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 static final HeaderElement[] parseAll(CharArrayBuffer buffer, int indexFrom, int indexTo)
buffer
- the buffer from which to parseindexFrom
- where to start parsing in the bufferindexTo
- where to stop parsing in the buffer
HeaderElement
s.public static final HeaderElement[] parseAll(java.lang.String s)
s
- the string representation of the header value
(as received from the web server).
HeaderElement
s.public static HeaderElement parse(CharArrayBuffer buffer, int indexFrom, int indexTo)
public static final HeaderElement parse(java.lang.String s)
public static void format(CharArrayBuffer buffer, HeaderElement element)
public static java.lang.String format(HeaderElement element)
public static void formatAll(CharArrayBuffer buffer, HeaderElement[] elements)
public static java.lang.String formatAll(HeaderElement[] elements)
public NameValuePair getParameterByName(java.lang.String name)
getParameterByName
in interface HeaderElement
name
- The name to search by.
public boolean equals(java.lang.Object object)
public int hashCode()
public java.lang.String toString()
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |