org.apache.http.message

Class BasicHeaderValueParserHC4

java.lang.Object

org.apache.http.message.BasicHeaderValueParserHC4

All Implemented Interfaces:

org.apache.http.message.HeaderValueParser

@Immutable
public class BasicHeaderValueParserHC4
extends java.lang.Object
implements org.apache.http.message.HeaderValueParser

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.

Since:

4.0

Field Summary

Fields

Modifier and Type	Field and Description
static BasicHeaderValueParserHC4	DEFAULT Deprecated. (4.3) use INSTANCE
static BasicHeaderValueParserHC4	INSTANCE

Constructor Summary

Constructors

Constructor and Description
BasicHeaderValueParserHC4()

Method Summary

Methods

Modifier and Type	Method and Description
protected org.apache.http.HeaderElement	createHeaderElement(java.lang.String name, java.lang.String value, org.apache.http.NameValuePair[] params) Creates a header element.
protected org.apache.http.NameValuePair	createNameValuePair(java.lang.String name, java.lang.String value) Creates a name-value pair.
org.apache.http.HeaderElement[]	parseElements(org.apache.http.util.CharArrayBuffer buffer, org.apache.http.message.ParserCursor cursor)
static org.apache.http.HeaderElement[]	parseElements(java.lang.String value, org.apache.http.message.HeaderValueParser parser) Parses elements with the given parser.
org.apache.http.HeaderElement	parseHeaderElement(org.apache.http.util.CharArrayBuffer buffer, org.apache.http.message.ParserCursor cursor)
static org.apache.http.HeaderElement	parseHeaderElement(java.lang.String value, org.apache.http.message.HeaderValueParser parser) Parses an element with the given parser.
org.apache.http.NameValuePair	parseNameValuePair(org.apache.http.util.CharArrayBuffer buffer, org.apache.http.message.ParserCursor cursor)
org.apache.http.NameValuePair	parseNameValuePair(org.apache.http.util.CharArrayBuffer buffer, org.apache.http.message.ParserCursor cursor, char[] delimiters)
static org.apache.http.NameValuePair	parseNameValuePair(java.lang.String value, org.apache.http.message.HeaderValueParser parser) Parses a name-value-pair with the given parser.
org.apache.http.NameValuePair[]	parseParameters(org.apache.http.util.CharArrayBuffer buffer, org.apache.http.message.ParserCursor cursor)
static org.apache.http.NameValuePair[]	parseParameters(java.lang.String value, org.apache.http.message.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

DEFAULT

@Deprecated
public static final BasicHeaderValueParserHC4 DEFAULT

Deprecated. (4.3) use INSTANCE

A default instance of this class, for use as default or fallback. Note that 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.

INSTANCE

public static final BasicHeaderValueParserHC4 INSTANCE

Constructor Detail

BasicHeaderValueParserHC4

public BasicHeaderValueParserHC4()

Method Detail

parseElements

public static org.apache.http.HeaderElement[] parseElements(java.lang.String value,
                                            org.apache.http.message.HeaderValueParser parser)
                                                     throws org.apache.http.ParseException

Parses elements with the given parser.

Parameters:

value - the header value to parse

parser - the parser to use, or null for default

Returns:

array holding the header elements, never null

Throws:

org.apache.http.ParseException

parseElements

public org.apache.http.HeaderElement[] parseElements(org.apache.http.util.CharArrayBuffer buffer,
                                            org.apache.http.message.ParserCursor cursor)

Specified by:

parseElements in interface org.apache.http.message.HeaderValueParser

parseHeaderElement

public static org.apache.http.HeaderElement parseHeaderElement(java.lang.String value,
                                               org.apache.http.message.HeaderValueParser parser)
                                                        throws org.apache.http.ParseException

Parses an element with the given parser.

Parameters:

value - the header element to parse

parser - the parser to use, or null for default

Returns:

the parsed header element

Throws:

org.apache.http.ParseException

parseHeaderElement

public org.apache.http.HeaderElement parseHeaderElement(org.apache.http.util.CharArrayBuffer buffer,
                                               org.apache.http.message.ParserCursor cursor)

Specified by:

parseHeaderElement in interface org.apache.http.message.HeaderValueParser

createHeaderElement

protected org.apache.http.HeaderElement createHeaderElement(java.lang.String name,
                                                java.lang.String value,
                                                org.apache.http.NameValuePair[] params)

Creates a header element. Called from parseHeaderElement(java.lang.String, org.apache.http.message.HeaderValueParser).

Returns:

a header element representing the argument

parseParameters

public static org.apache.http.NameValuePair[] parseParameters(java.lang.String value,
                                              org.apache.http.message.HeaderValueParser parser)
                                                       throws org.apache.http.ParseException

Parses parameters with the given parser.

Parameters:

value - the parameter list to parse

parser - the parser to use, or null for default

Returns:

array holding the parameters, never null

Throws:

org.apache.http.ParseException

parseParameters

public org.apache.http.NameValuePair[] parseParameters(org.apache.http.util.CharArrayBuffer buffer,
                                              org.apache.http.message.ParserCursor cursor)

Specified by:

parseParameters in interface org.apache.http.message.HeaderValueParser

parseNameValuePair

public static org.apache.http.NameValuePair parseNameValuePair(java.lang.String value,
                                               org.apache.http.message.HeaderValueParser parser)
                                                        throws org.apache.http.ParseException

Parses a name-value-pair with the given parser.

Parameters:

value - the NVP to parse

parser - the parser to use, or null for default

Returns:

the parsed name-value pair

Throws:

org.apache.http.ParseException

parseNameValuePair

public org.apache.http.NameValuePair parseNameValuePair(org.apache.http.util.CharArrayBuffer buffer,
                                               org.apache.http.message.ParserCursor cursor)

Specified by:

parseNameValuePair in interface org.apache.http.message.HeaderValueParser

parseNameValuePair

public org.apache.http.NameValuePair parseNameValuePair(org.apache.http.util.CharArrayBuffer buffer,
                                               org.apache.http.message.ParserCursor cursor,
                                               char[] delimiters)

createNameValuePair

protected org.apache.http.NameValuePair createNameValuePair(java.lang.String name,
                                                java.lang.String value)

Creates a name-value pair. Called from parseNameValuePair(java.lang.String, org.apache.http.message.HeaderValueParser).

Parameters:

name - the name

value - the value, or null

Returns:

a name-value pair representing the arguments