Top Description Inners Constructors Methods
io.undertow.util

public Class QValueParser

extends Object
Class Inheritance
Imports
java.util.ArrayList, .Collections, .List

Utility class for parsing headers that accept q values
Author
Stuart Douglas

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Constructor Summary

AccessConstructor and Description
private

Method Summary

Modifier and TypeMethod and Description
private static QValueParser.QValueResult
handleNewEncoding(final List<QValueParser.QValueResult> found, final String header, final int stringStart, final int i)

public static List<List<QValueParser.QValueResult>>

Returns:

The q value results
parse
(List<String>
The headers
headers
)

Parses a set of headers that take q values to determine the most preferred one.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Constructor Detail

QValueParserback to summary
private QValueParser()

Method Detail

handleNewEncodingback to summary
private static QValueParser.QValueResult handleNewEncoding(final List<QValueParser.QValueResult> found, final String header, final int stringStart, final int i)
parseback to summary
public static List<List<QValueParser.QValueResult>> parse(List<String> headers)

Parses a set of headers that take q values to determine the most preferred one. It returns the result in the form of a sorted list of list, with every element in the list having the same q value. This means the highest priority items are at the front of the list. The container should use its own internal preferred ordering to determinately pick the correct item to use

Parameters
headers:List<String>

The headers

Returns:List<List<QValueParser.QValueResult>>

The q value results

io.undertow.util back to summary

public Class QValueParser.QValueResult

extends Object
implements Comparable<QValueParser.QValueResult>
Class Inheritance
All Implemented Interfaces
java.lang.Comparable

Field Summary

Modifier and TypeField and Description
private String
qvalue

we keep the qvalue as a string to avoid parsing the double.

private String
value

The string value of the result

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public int
compareTo(final QValueParser.QValueResult
the object to be compared.
other
)

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.
o
)

Overrides java.lang.Object.equals.

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

public String
public String
public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

public boolean
Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAlltoStringwaitwaitwait

Field Detail

qvalueback to summary
private String qvalue

we keep the qvalue as a string to avoid parsing the double.

This should give both performance and also possible security improvements

valueback to summary
private String value

The string value of the result

Constructor Detail

QValueResultback to summary
public QValueResult()

Method Detail

compareToback to summary
public int compareTo(final QValueParser.QValueResult other)

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
other:QValueParser.QValueResult

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 o)

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
o: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
getQvalueback to summary
public String getQvalue()
getValueback to summary
public 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
isQValueZeroback to summary
public boolean isQValueZero()