|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.apache.http.message.BasicHeaderValueParser
@Immutable public class BasicHeaderValueParser
Basic implementation for parsing header values into elements. Instances of this class are stateless and thread-safe. Derived classes are expected to maintain these properties.
| Field Summary | |
|---|---|
static BasicHeaderValueParser |
DEFAULT
A default instance of this class, for use as default or fallback. |
| Constructor Summary | |
|---|---|
BasicHeaderValueParser()
|
|
| Method Summary | |
|---|---|
protected HeaderElement |
createHeaderElement(String name,
String value,
NameValuePair[] params)
Creates a header element. |
protected NameValuePair |
createNameValuePair(String name,
String value)
Creates a name-value pair. |
HeaderElement[] |
parseElements(CharArrayBuffer buffer,
ParserCursor cursor)
Parses a header value into elements. |
static HeaderElement[] |
parseElements(String value,
HeaderValueParser parser)
Parses elements with the given parser. |
HeaderElement |
parseHeaderElement(CharArrayBuffer buffer,
ParserCursor cursor)
Parses a single header element. |
static HeaderElement |
parseHeaderElement(String value,
HeaderValueParser parser)
Parses an element with the given parser. |
NameValuePair |
parseNameValuePair(CharArrayBuffer buffer,
ParserCursor cursor)
Parses a name=value specification, where the = and value are optional. |
NameValuePair |
parseNameValuePair(CharArrayBuffer buffer,
ParserCursor cursor,
char[] delimiters)
|
static NameValuePair |
parseNameValuePair(String value,
HeaderValueParser parser)
Parses a name-value-pair with the given parser. |
NameValuePair[] |
parseParameters(CharArrayBuffer buffer,
ParserCursor cursor)
Parses a list of name-value pairs. |
static NameValuePair[] |
parseParameters(String value,
HeaderValueParser parser)
Parses parameters with the given parser. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
public static final BasicHeaderValueParser DEFAULT
BasicHeaderValueParser is not a singleton, there
can be many instances of the class itself and of derived classes.
The instance here provides non-customized, default behavior.
| Constructor Detail |
|---|
public BasicHeaderValueParser()
| Method Detail |
|---|
public static final HeaderElement[] parseElements(String value,
HeaderValueParser parser)
throws ParseException
value - the header value to parseparser - the parser to use, or null for default
null
ParseException
public HeaderElement[] parseElements(CharArrayBuffer buffer,
ParserCursor cursor)
HeaderValueParserRuntimeException.
Some HTTP headers (such as the set-cookie header) have values that can be decomposed into multiple elements. In order to be processed by this parser, 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.
parseElements in interface HeaderValueParserbuffer - buffer holding the header value to parsecursor - the parser cursor containing the current position and
the bounds within the buffer for the parsing operation
public static final HeaderElement parseHeaderElement(String value,
HeaderValueParser parser)
throws ParseException
value - the header element to parseparser - the parser to use, or null for default
ParseException
public HeaderElement parseHeaderElement(CharArrayBuffer buffer,
ParserCursor cursor)
HeaderValueParser
parseHeaderElement in interface HeaderValueParserbuffer - buffer holding the element to parsecursor - the parser cursor containing the current position and
the bounds within the buffer for the parsing operation
protected HeaderElement createHeaderElement(String name,
String value,
NameValuePair[] params)
parseHeaderElement(java.lang.String, org.apache.http.message.HeaderValueParser).
public static final NameValuePair[] parseParameters(String value,
HeaderValueParser parser)
throws ParseException
value - the parameter list to parseparser - the parser to use, or null for default
null
ParseException
public NameValuePair[] parseParameters(CharArrayBuffer buffer,
ParserCursor cursor)
HeaderValueParserParseException.
parseParameters in interface HeaderValueParserbuffer - buffer holding the name-value list to parsecursor - the parser cursor containing the current position and
the bounds within the buffer for the parsing operation
public static final NameValuePair parseNameValuePair(String value,
HeaderValueParser parser)
throws ParseException
value - the NVP to parseparser - the parser to use, or null for default
ParseException
public NameValuePair parseNameValuePair(CharArrayBuffer buffer,
ParserCursor cursor)
HeaderValueParser
parseNameValuePair in interface HeaderValueParserbuffer - the buffer holding the name-value pair to parsecursor - the parser cursor containing the current position and
the bounds within the buffer for the parsing operation
null
if no value is specified
public NameValuePair parseNameValuePair(CharArrayBuffer buffer,
ParserCursor cursor,
char[] delimiters)
protected NameValuePair createNameValuePair(String name,
String value)
parseNameValuePair(java.lang.String, org.apache.http.message.HeaderValueParser).
name - the namevalue - the value, or null
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||