Top Description Inners Fields Constructors Methods
org.eclipse.jetty.http

public Class QuotedQualityCSV

extends QuotedCSV
implements Iterable<String>
Class Inheritance
All Implemented Interfaces
java.lang.Iterable
Imports
java.util.ArrayList, .Iterator, .List, .Objects, java.util.function.ToIntFunction, java.util.stream.Collectors, org.slf4j.Logger, .LoggerFactory

Implements a quoted comma separated list of quality values in accordance with RFC7230 and RFC7231. Values are returned sorted in quality order, with OWS and the quality parameters removed.
See Also
https://tools.ietf.org/html/rfc7230#section-3.2.6, https://tools.ietf.org/html/rfc7230#section-7, https://tools.ietf.org/html/rfc7231#section-5.3.1

Nested and Inner Type Summary

Modifier and TypeClass and Description
private class

Field Summary

Modifier and TypeField and Description
private QuotedQualityCSV.QualityValue
private final List<QuotedQualityCSV.QualityValue>
private final ToIntFunction<String>
private boolean
private static final Logger
public static ToIntFunction<String>
MOST_SPECIFIC_MIME_ORDERING

Lambda to apply a most specific MIME encoding secondary ordering.

Inherited from org.eclipse.jetty.http.QuotedCSV:
_values

Constructor Summary

AccessConstructor and Description
public
QuotedQualityCSV()

Sorts values with equal quality according to the length of the value String.

public
QuotedQualityCSV(String[]
Array indicating the preferred order of known values
preferredOrder
)

Sorts values with equal quality according to given order.

public
QuotedQualityCSV(List<String>
Array indicating the preferred order of known values
preferredOrder
)

Sorts values with equal quality according to given order.

public
QuotedQualityCSV(ToIntFunction<String>
Function to apply an ordering other than specified by quality, highest values are sorted first.
secondaryOrdering
)

Orders values with equal quality with the given function.

Method Summary

Modifier and TypeMethod and Description
public List<String>
public Iterator<String>
iterator()

Overrides org.eclipse.jetty.http.QuotedCSV.iterator.

Implements java.lang.Iterable.iterator.

Returns an iterator over elements of type T.

protected void
parsedParam(StringBuffer
Containing the trimmed value and all parameters, which may be mutated
buffer
,
int
The length of the value
valueLength
,
int
The index of the start of the parameter just parsed
paramName
,
int
The index of the start of the parameter value just parsed, or -1
paramValue
)

Overrides org.eclipse.jetty.http.QuotedCSVParser.parsedParam.

Called when a parameter has been parsed

protected void
parsedValue(StringBuffer
Containing the trimmed value, which may be mutated
buffer
)

Overrides org.eclipse.jetty.http.QuotedCSVParser.parsedValue.

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

protected void
parsedValueAndParams(StringBuffer
Containing the trimmed value and parameters
buffer
)

Overrides org.eclipse.jetty.http.QuotedCSV.parsedValueAndParams.

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

protected void
sort()

Inherited from org.eclipse.jetty.http.QuotedCSV:
isEmptyjoinjoinjoinsizetoString

Field Detail

_lastQualityback to summary
private QuotedQualityCSV.QualityValue _lastQuality
_qualitiesback to summary
private final List<QuotedQualityCSV.QualityValue> _qualities
_secondaryOrderingback to summary
private final ToIntFunction<String> _secondaryOrdering
_sortedback to summary
private boolean _sorted
LOGback to summary
private static final Logger LOG
MOST_SPECIFIC_MIME_ORDERINGback to summary
public static ToIntFunction<String> MOST_SPECIFIC_MIME_ORDERING

Lambda to apply a most specific MIME encoding secondary ordering.

See Also
https://tools.ietf.org/html/rfc7231#section-5.3.2

Constructor Detail

QuotedQualityCSVback to summary
public QuotedQualityCSV()

Sorts values with equal quality according to the length of the value String.

QuotedQualityCSVback to summary
public QuotedQualityCSV(String[] preferredOrder)

Sorts values with equal quality according to given order.

Parameters
preferredOrder:String[]

Array indicating the preferred order of known values

QuotedQualityCSVback to summary
public QuotedQualityCSV(List<String> preferredOrder)

Sorts values with equal quality according to given order.

Parameters
preferredOrder:List<String>

Array indicating the preferred order of known values

QuotedQualityCSVback to summary
public QuotedQualityCSV(ToIntFunction<String> secondaryOrdering)

Orders values with equal quality with the given function.

Parameters
secondaryOrdering:ToIntFunction<String>

Function to apply an ordering other than specified by quality, highest values are sorted first.

Method Detail

getValuesback to summary
public List<String> getValues()

Overrides org.eclipse.jetty.http.QuotedCSV.getValues.

Annotations
@Override
iteratorback to summary
public Iterator<String> iterator()

Overrides org.eclipse.jetty.http.QuotedCSV.iterator.

Implements java.lang.Iterable.iterator.

Doc from java.lang.Iterable.iterator.

Returns an iterator over elements of type T.

Returns:Iterator<String>

an Iterator.

Annotations
@Override
parsedParamback to summary
protected void parsedParam(StringBuffer buffer, int valueLength, int paramName, int paramValue)

Overrides org.eclipse.jetty.http.QuotedCSVParser.parsedParam.

Doc from org.eclipse.jetty.http.QuotedCSVParser.parsedParam.

Called when a parameter has been parsed

Parameters
buffer:StringBuffer

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

valueLength:int

The length of the value

paramName:int

The index of the start of the parameter just parsed

paramValue:int

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

Annotations
@Override
parsedValueback to summary
protected void parsedValue(StringBuffer buffer)

Overrides org.eclipse.jetty.http.QuotedCSVParser.parsedValue.

Doc from org.eclipse.jetty.http.QuotedCSVParser.parsedValue.

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

Parameters
buffer:StringBuffer

Containing the trimmed value, which may be mutated

Annotations
@Override
parsedValueAndParamsback to summary
protected void parsedValueAndParams(StringBuffer buffer)

Overrides org.eclipse.jetty.http.QuotedCSV.parsedValueAndParams.

Doc from org.eclipse.jetty.http.QuotedCSVParser.parsedValueAndParams.

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

Parameters
buffer:StringBuffer

Containing the trimmed value and parameters

Annotations
@Override
sortback to summary
protected void sort()
org.eclipse.jetty.http back to summary

private Class QuotedQualityCSV.QualityValue

extends Object
implements Comparable<QuotedQualityCSV.QualityValue>
Class Inheritance
All Implemented Interfaces
java.lang.Comparable

Field Summary

Modifier and TypeField and Description
private final int
private final double
private final String

Constructor Summary

AccessConstructor and Description
private
QualityValue(double quality, String value, int index)

Method Summary

Modifier and TypeMethod and Description
public int
compareTo(QuotedQualityCSV.QualityValue
the object to be compared.
o
)

Implements java.lang.Comparable.compareTo.

Compares this object with the specified object for order.

public boolean
equals(Object
the reference object with which to compare.
obj
)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

private String
public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

_indexback to summary
private final int _index
_qualityback to summary
private final double _quality
_valueback to summary
private final String _value

Constructor Detail

QualityValueback to summary
private QualityValue(double quality, String value, int index)

Method Detail

compareToback to summary
public int compareTo(QuotedQualityCSV.QualityValue o)

Implements java.lang.Comparable.compareTo.

Doc from java.lang.Comparable.compareTo.

Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

The implementor must ensure signum(x.compareTo(y)) == -signum(y.compareTo(x)) for all x and y. (This implies that x.compareTo(y) must throw an exception if and only if y.compareTo(x) throws an exception.)

The implementor must also ensure that the relation is transitive: (x.compareTo(y) > 0 && y.compareTo(z) > 0) implies x.compareTo(z) > 0.

Finally, the implementor must ensure that x.compareTo(y)==0 implies that signum(x.compareTo(z)) == signum(y.compareTo(z)), for all z.

Parameters
o:QuotedQualityCSV.QualityValue

the object to be compared.

Returns:int

a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

Annotations
@Override
equalsback to summary
public boolean equals(Object obj)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
obj:Object

the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations
@Override
getValueback to summary
private String getValue()
hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Returns:int

a hash code value for this object

Annotations
@Override
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations
@Override