Top Description Methods
org.apache.hc.core5.http.message

public Interface HeaderValueParser

Known Direct Implementers
org.apache.hc.core5.http.message.BasicHeaderValueParser
Imports
org.apache.hc.core5.http.HeaderElement, .NameValuePair

Interface for parsing header values into elements. Instances of this interface are expected to be stateless and thread-safe.
Since
4.0

Method Summary

Modifier and TypeMethod and Description
public HeaderElement[]

Returns:

an array holding all elements of the header value
parseElements
(CharSequence
buffer holding the header value to parse
buffer
,
ParserCursor
the parser cursor containing the current position and the bounds within the buffer for the parsing operation
cursor
)

Parses a header value into elements.

public HeaderElement

Returns:

the parsed element
parseHeaderElement
(CharSequence
buffer holding the element to parse
buffer
,
ParserCursor
the parser cursor containing the current position and the bounds within the buffer for the parsing operation
cursor
)

Parses a single header element.

public NameValuePair

Returns:

the name-value pair, where the value is null if no value is specified
parseNameValuePair
(CharSequence
the buffer holding the name-value pair to parse
buffer
,
ParserCursor
the parser cursor containing the current position and the bounds within the buffer for the parsing operation
cursor
)

Parses a name=value specification, where the = and value are optional.

public NameValuePair[]

Returns:

an array holding all items of the name-value list
parseParameters
(CharSequence
buffer holding the name-value list to parse
buffer
,
ParserCursor
the parser cursor containing the current position and the bounds within the buffer for the parsing operation
cursor
)

Parses a list of name-value pairs.

Method Detail

parseElementsback to summary
public HeaderElement[] parseElements(CharSequence buffer, ParserCursor cursor)

Parses a header value into elements. Parse errors are indicated as RuntimeException.

Parameters
buffer:CharSequence

buffer holding the header value to parse

cursor:ParserCursor

the parser cursor containing the current position and the bounds within the buffer for the parsing operation

Returns:HeaderElement[]

an array holding all elements of the header value

parseHeaderElementback to summary
public HeaderElement parseHeaderElement(CharSequence buffer, ParserCursor cursor)

Parses a single header element. A header element consist of a semicolon-separate list of name=value definitions.

Parameters
buffer:CharSequence

buffer holding the element to parse

cursor:ParserCursor

the parser cursor containing the current position and the bounds within the buffer for the parsing operation

Returns:HeaderElement

the parsed element

parseNameValuePairback to summary
public NameValuePair parseNameValuePair(CharSequence buffer, ParserCursor cursor)

Parses a name=value specification, where the = and value are optional.

Parameters
buffer:CharSequence

the buffer holding the name-value pair to parse

cursor:ParserCursor

the parser cursor containing the current position and the bounds within the buffer for the parsing operation

Returns:NameValuePair

the name-value pair, where the value is null if no value is specified

parseParametersback to summary
public NameValuePair[] parseParameters(CharSequence buffer, ParserCursor cursor)

Parses a list of name-value pairs. These lists are used to specify parameters to a header element. Parse errors are indicated as ParseException.

Parameters
buffer:CharSequence

buffer holding the name-value list to parse

cursor:ParserCursor

the parser cursor containing the current position and the bounds within the buffer for the parsing operation

Returns:NameValuePair[]

an array holding all items of the name-value list