Package org.eclipse.jetty.http

Class QuotedCSV

java.lang.Object

org.eclipse.jetty.http.QuotedCSVParser

org.eclipse.jetty.http.QuotedCSV

All Implemented Interfaces:

Iterable<String>

Direct Known Subclasses:

QuotedCSV.Compliant, QuotedQualityCSV

public class QuotedCSV
extends QuotedCSVParser
implements Iterable<String>

Implements a quoted comma-separated list of values 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"

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	QuotedCSV.Compliant	Deprecated, for removal: This API element is subject to removal in a future version. use QuotedCSV instead
static class	QuotedCSV.Etags

Field Summary

Fields inherited from class org.eclipse.jetty.http.QuotedCSVParser

_keepQuotes, DELIMITERS, LIST_TOKENIZER

Constructor Summary

Constructors

Constructor	Description
QuotedCSV(boolean keepQuotes, String... values)
QuotedCSV(String... values)
QuotedCSV(ComplianceViolation.Mode compliance, ComplianceViolation.Listener listener, boolean keepQuotes, String... values)

Method Summary

Modifier and Type	Method	Description
String	asString()
List<String>	getMutableValues()
List<String>	getValues()
boolean	isEmpty()
Iterator<String>	iterator()
static String	join(String... values)	Join a list into Quoted CSV string
static void	join(StringBuilder builder, List<String> values)	Join a list into Quoted CSV StringBuilder
static String	join(List<String> values)	Join a list into Quoted CSV string
protected void	onComplianceViolation(ComplianceViolation violation, String value)	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	parsedValueAndParams(StringBuilder buffer)	Called when a value and it's parameters has been parsed
int	size()
String	toString()

Methods inherited from class org.eclipse.jetty.http.QuotedCSVParser

addValue, onComplianceViolation, openingQuoteInValue, parsedValue, quote, quoteIfNeeded, unquote

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Details

QuotedCSV

public QuotedCSV(String... values)

QuotedCSV

public QuotedCSV(boolean keepQuotes,
 String... values)

QuotedCSV

public QuotedCSV(ComplianceViolation.Mode compliance,
 ComplianceViolation.Listener listener,
 boolean keepQuotes,
 String... values)

Method Details

join

public static String join(List<String> values)

Join a list into Quoted CSV string

Parameters:

values - A list of values

Returns:

A Quoted Comma Separated Value list

join

public static String join(String... values)

Join a list into Quoted CSV string

Parameters:

values - A list of values

Returns:

A Quoted Comma Separated Value list

join

public static void join(StringBuilder builder,
 List<String> values)

Join a list into Quoted CSV StringBuilder

Parameters:

builder - A builder to join the list into

values - A list of values

parsedValueAndParams

protected void parsedValueAndParams(StringBuilder buffer)

Description copied from class: QuotedCSVParser

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

Overrides:

parsedValueAndParams in class QuotedCSVParser

Parameters:

buffer - Containing the trimmed value and parameters

parsedParam

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

Description copied from class: QuotedCSVParser

Called when a parameter has been parsed

Overrides:

parsedParam in class QuotedCSVParser

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

size

public int size()

isEmpty

public boolean isEmpty()

getValues

public List<String> getValues()

getMutableValues

public List<String> getMutableValues()

iterator

public Iterator<String> iterator()

Specified by:

iterator in interface Iterable<String>

onComplianceViolation

protected void onComplianceViolation(ComplianceViolation violation,
 String value)

Description copied from class: QuotedCSVParser

Called when a parameter has been parsed with bad white space

Overrides:

onComplianceViolation in class QuotedCSVParser

asString

public String asString()

toString

public String toString()

Overrides:

toString in class Object