org.apache.commons.httpclient
Class HeaderElement
- Serializable
public class HeaderElement
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(String)
method for parsing a
Header
value into an array of elements.
$Revision: 155418 $ $Date: 2005-02-26 08:01:52 -0500 (Sat, 26 Feb 2005) $
HeaderElement
public HeaderElement()
Default constructor.
HeaderElement
public HeaderElement(String name,
String value)
Constructor.
name
- my namevalue
- my (possibly null) value
HeaderElement
public HeaderElement(String name,
String value,
NameValuePair[] parameters)
Constructor with name, value and parameters.
name
- my namevalue
- my (possibly null) valueparameters
- my (possibly null) parameters
HeaderElement
public HeaderElement(char[] chars)
Constructor with array of characters.
chars
- the array of characters
HeaderElement
public HeaderElement(char[] chars,
int offset,
int length)
Constructor with array of characters.
chars
- the array of charactersoffset
- - the initial offset.length
- - the length.
getParameterByName
public NameValuePair getParameterByName(String name)
Returns parameter with the given name, if found. Otherwise null
is returned
name
- The name to search by.
- NameValuePair parameter with the given name
getParameters
public NameValuePair[] getParameters()
Get parameters, if any.
parse
public static final HeaderElement[] parse(String headerValue)
throws HttpException
Use #parseElements(String).
This parses the value part of a header. The result is an array of
HeaderElement objects.
headerValue
- the string representation of the header value
(as received from the web server).
parseElements
public static final HeaderElement[] parseElements(String headerValue)
This parses the value part of a header. The result is an array of
HeaderElement objects.
headerValue
- the string representation of the header value
(as received from the web server).
parseElements
public static final HeaderElement[] parseElements(char[] headerValue)
This parses the value part of a header. The result is an array of
HeaderElement objects.
headerValue
- the array of char representation of the header value
(as received from the web server).
Copyright (c) 1999-2005 - Apache Software Foundation