Package com.helger.http.header

Class QValue

java.lang.Object

com.helger.http.header.QValue

All Implemented Interfaces:

Comparable<QValue>

@Immutable
public class QValue
extends Object
implements Comparable<QValue>

Represents the quality value of an HTTP Accept* header.

Author:

Philip Helger

Field Summary

Fields

Modifier and Type	Field	Description
static final double	HALF_QUALITY	50% quantile quality value: 0.5
static final double	MAX_QUALITY	Maximum quality value: 1
static final QValue	MAX_QVALUE	Maximum quality: 1
static final double	MIN_QUALITY	Minimum quality value: 0
static final QValue	MIN_QVALUE	Minimum quality: 0

Constructor Summary

Constructors

Constructor	Description
QValue(double dQuality)	Constructor with quality value.

Method Summary

Modifier and Type	Method	Description
int	compareTo(@NonNull QValue rhs)
boolean	equals(Object o)
double	getQuality()
static double	getValueInRange(double dQuality)	Get the passed value in the range MIN_QUALITY and MAX_QUALITY.
int	hashCode()
boolean	isAboveMinimumQuality()
boolean	isBelowMaximumQuality()
boolean	isBetweenMinimumAndMaximum()
boolean	isHighValue()
boolean	isLowValue()
boolean	isMaximumQuality()
boolean	isMinimumQuality()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

MIN_QUALITY

public static final double MIN_QUALITY

Minimum quality value: 0

See Also:

• Constant Field Values

MAX_QUALITY

public static final double MAX_QUALITY

Maximum quality value: 1

See Also:

• Constant Field Values

HALF_QUALITY

public static final double HALF_QUALITY

50% quantile quality value: 0.5

See Also:

• Constant Field Values

MIN_QVALUE

public static final QValue MIN_QVALUE

Minimum quality: 0

MAX_QVALUE

public static final QValue MAX_QVALUE

Maximum quality: 1

Constructor Details

QValue

public QValue(@Nonnegative
 double dQuality)

Constructor with quality value. The value will be clamped to the range [MIN_QUALITY, MAX_QUALITY].

Parameters:

dQuality - The quality value. Should be between 0 and 1.

Method Details

getValueInRange

public static double getValueInRange(double dQuality)

Get the passed value in the range MIN_QUALITY and MAX_QUALITY.

Parameters:

dQuality - Source value

Returns:

Aligned value ≥ MIN_QUALITY and ≤ MAX_QUALITY.

getQuality

@Nonnegative
public double getQuality()

Returns:

The quality value in the range [MIN_QUALITY, MAX_QUALITY].

isMinimumQuality

public boolean isMinimumQuality()

Returns:

true if the quality is MIN_QUALITY

isAboveMinimumQuality

public boolean isAboveMinimumQuality()

Returns:

true if the quality is > MIN_QUALITY

isLowValue

public boolean isLowValue()

Returns:

true if the quality is ≤ HALF_QUALITY

See Also:

• isHighValue()

isHighValue

public boolean isHighValue()

Returns:

true if the quality is > HALF_QUALITY

See Also:

• isLowValue()

isBelowMaximumQuality

public boolean isBelowMaximumQuality()

Returns:

true if the quality is < MAX_QUALITY

isMaximumQuality

public boolean isMaximumQuality()

Returns:

true if the quality is MAX_QUALITY

isBetweenMinimumAndMaximum

public boolean isBetweenMinimumAndMaximum()

Returns:

true if the quality is > MIN_QUALITY and < MAX_QUALITY.

See Also:

• isAboveMinimumQuality()
• isBelowMaximumQuality()

compareTo

public int compareTo(@NonNull QValue rhs)

Specified by:

compareTo in interface Comparable<QValue>

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object