Class QuotedCSVParser

java.lang.Object

org.eclipse.jetty.http.QuotedCSVParser

Direct Known Subclasses:

QuotedCSV

public abstract class QuotedCSVParser
extends Object

Implements a quoted comma-separated list parser in accordance with RFC9110 section 5.5 and RFC9110 section 5.6. OWS is removed and quoted characters ignored for parsing.

See Also:

• "https://datatracker.ietf.org/doc/html/rfc9110#section-5.5"
• "https://datatracker.ietf.org/doc/html/rfc9110#section-5.6"

Field Summary

Fields

Modifier and Type	Field	Description
protected final boolean	_keepQuotes
static final String	DELIMITERS
static final QuotedStringTokenizer	LIST_TOKENIZER

Constructor Summary

Constructors

Constructor	Description
QuotedCSVParser(boolean keepQuotes)

Method Summary

Modifier and Type	Method	Description
void	addValue(String value)	Add and parse a value string(s)
protected void	onComplianceViolation(ComplianceViolation violation)	Called when a parameter has been parsed with bad white space
protected void	parsedParam(StringBuilder buffer, int valueLength, int paramName, int paramValue)	Called when a parameter has been parsed
protected void	parsedValue(StringBuilder buffer)	Called when a value has been parsed (prior to any parameters)
protected void	parsedValueAndParams(StringBuilder buffer)	Called when a value and it's parameters has been parsed
static String	quote(String s)
static String	quoteIfNeeded(String s)
static String	unquote(String s)

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

DELIMITERS

public static final String DELIMITERS

See Also:

• Constant Field Values

LIST_TOKENIZER

public static final QuotedStringTokenizer LIST_TOKENIZER

_keepQuotes

protected final boolean _keepQuotes

Constructor Details

QuotedCSVParser

public QuotedCSVParser(boolean keepQuotes)

Method Details

quote

public static String quote(String s)

quoteIfNeeded

public static String quoteIfNeeded(String s)

unquote

public static String unquote(String s)

addValue

public void addValue(String value)

Add and parse a value string(s)

Parameters:

value - A value that may contain one or more Quoted CSV items.

parsedValueAndParams

protected void parsedValueAndParams(StringBuilder buffer)

Called when a value and it's parameters has been parsed

Parameters:

buffer - Containing the trimmed value and parameters

parsedValue

protected void parsedValue(StringBuilder buffer)

Called when a value has been parsed (prior to any parameters)

Parameters:

buffer - Containing the trimmed value, which may be mutated

parsedParam

protected void parsedParam(StringBuilder buffer,
 int valueLength,
 int paramName,
 int paramValue)

Called when a parameter has been parsed

Parameters:

buffer - Containing the trimmed value and all parameters, which may be mutated

valueLength - The length of the value

paramName - The index of the start of the parameter just parsed

paramValue - The index of the start of the parameter value just parsed, or -1

onComplianceViolation

protected void onComplianceViolation(ComplianceViolation violation)

Called when a parameter has been parsed with bad white space