| 
 | ||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.apache.commons.httpclient.NameValuePair
org.apache.commons.httpclient.HeaderElement
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(java.lang.String) method for parsing a
 Header value into an array of elements.
 
Header, 
Serialized Form| Constructor Summary | |
|---|---|
| HeaderElement()Default constructor. | |
| HeaderElement(char[] chars)Constructor with array of characters. | |
| HeaderElement(char[] chars,
              int offset,
              int length)Constructor with array of characters. | |
| HeaderElement(String name,
              String value)Constructor. | |
| HeaderElement(String name,
              String value,
              NameValuePair[] parameters)Constructor with name, value and parameters. | |
| Method Summary | |
|---|---|
|  NameValuePair | getParameterByName(String name)Returns parameter with the given name, if found. | 
|  NameValuePair[] | getParameters()Get parameters, if any. | 
| static HeaderElement[] | parse(String headerValue)Deprecated. Use #parseElements(String). | 
| static HeaderElement[] | parseElements(char[] headerValue)This parses the value part of a header. | 
| static HeaderElement[] | parseElements(String headerValue)This parses the value part of a header. | 
| Methods inherited from class org.apache.commons.httpclient.NameValuePair | 
|---|
| equals, getName, getValue, hashCode, setName, setValue, toString | 
| Methods inherited from class java.lang.Object | 
|---|
| clone, finalize, getClass, notify, notifyAll, wait, wait, wait | 
| Constructor Detail | 
|---|
public HeaderElement()
public HeaderElement(String name,
                     String value)
name - my namevalue - my (possibly null) value
public HeaderElement(String name,
                     String value,
                     NameValuePair[] parameters)
name - my namevalue - my (possibly null) valueparameters - my (possibly null) parameters
public HeaderElement(char[] chars,
                     int offset,
                     int length)
chars - the array of charactersoffset - - the initial offset.length - - the length.public HeaderElement(char[] chars)
chars - the array of characters| Method Detail | 
|---|
public NameValuePair[] getParameters()
NameValuePairspublic static final HeaderElement[] parseElements(char[] headerValue)
headerValue - the array of char representation of the header value
                     (as received from the web server).
HeaderElements.public static final HeaderElement[] parseElements(String headerValue)
headerValue - the string representation of the header value
                     (as received from the web server).
HeaderElements.
public static final HeaderElement[] parse(String headerValue)
                                   throws HttpException
headerValue - the string representation of the header value
                     (as received from the web server).
HeaderElements.
HttpException - if the above syntax rules are violated.public NameValuePair getParameterByName(String name)
name - The name to search by.
| 
 | ||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||