Package org.apache.hc.core5.http.message
Interface HeaderValueParser
- All Known Implementing Classes:
BasicHeaderValueParser
public interface HeaderValueParser
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 TypeMethodDescriptionparseElements
(CharSequence buffer, ParserCursor cursor) Parses a header value into elements.parseHeaderElement
(CharSequence buffer, ParserCursor cursor) Parses a single header element.parseNameValuePair
(CharSequence buffer, ParserCursor cursor) Parses a name=value specification, where the = and value are optional.parseParameters
(CharSequence buffer, ParserCursor cursor) Parses a list of name-value pairs.
-
Method Details
-
parseElements
Parses a header value into elements. Parse errors are indicated asRuntimeException
.- Parameters:
buffer
- buffer holding the header value to parsecursor
- the parser cursor containing the current position and the bounds within the buffer for the parsing operation- Returns:
- an array holding all elements of the header value
-
parseHeaderElement
Parses a single header element. A header element consist of a semicolon-separate list of name=value definitions.- Parameters:
buffer
- buffer holding the element to parsecursor
- the parser cursor containing the current position and the bounds within the buffer for the parsing operation- Returns:
- the parsed element
-
parseParameters
Parses a list of name-value pairs. These lists are used to specify parameters to a header element. Parse errors are indicated asParseException
.- Parameters:
buffer
- 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- Returns:
- an array holding all items of the name-value list
-
parseNameValuePair
Parses a name=value specification, where the = and value are optional.- Parameters:
buffer
- 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- Returns:
- the name-value pair, where the value is
null
if no value is specified
-