Units of Measurement Common Library for Java 2.2 · tech.uom.lib.common.util.NaturalQuantityComparator

public Class NaturalQuantityComparator<T extends Quantity<T>>

extends Object
implements Comparator<Quantity<T extends Quantity<T>>>

Class Inheritance

java.lang.Object
tech.uom.lib.common.util.NaturalQuantityComparator

All Implemented Interfaces

java.util.Comparator

Type Parameters

<T>: the type of quantity

Imports

java.util.Comparator, javax.measure.Quantity

Comparator to sort quantities by natural order, looking both the unit and the value.

Constructor Summary

Access	Constructor and Description
public	NaturalQuantityComparator()

Method Summary

Modifier and Type	Method and Description
public int	compare(Quantity<T> the first object to be compared. q1, Quantity<T> the second object to be compared. q2) Implements java.util.Comparator.compare. Compares its two arguments for order.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Detail

NaturalQuantityComparator	back to summary
public NaturalQuantityComparator()

Method Detail

compare back to summary

compare	back to summary
public int compare(Quantity<T> q1, Quantity<T> q2) Implements java.util.Comparator.compare. Doc from java.util.Comparator.compare. Compares its two arguments for order. Returns a negative integer, zero, or a positive integer as the first argument is less than, equal to, or greater than the second. The implementor must ensure that `signum(compare(x, y)) == -signum(compare(y, x))` for all `x` and `y`. (This implies that `compare(x, y)` must throw an exception if and only if `compare(y, x)` throws an exception.) The implementor must also ensure that the relation is transitive: `((compare(x, y)>0) && (compare(y, z)>0))` implies `compare(x, z)>0`. Finally, the implementor must ensure that `compare(x, y)==0` implies that `signum(compare(x, z))==signum(compare(y, z))` for all `z`. Parameters q1:Quantity<T> the first object to be compared. q2:Quantity<T> the second object to be compared. Returns:int a negative integer, zero, or a positive integer as the first argument is less than, equal to, or greater than the second. Annotations @Override

public int compare(Quantity<T> q1, Quantity<T> q2)

Implements java.util.Comparator.compare.

Doc from java.util.Comparator.compare.

Compares its two arguments for order. Returns a negative integer, zero, or a positive integer as the first argument is less than, equal to, or greater than the second.

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

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

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

Parameters

q1:Quantity<T>: the first object to be compared.
q2:Quantity<T>: the second object to be compared.

Returns:int

a negative integer, zero, or a positive integer as the first argument is less than, equal to, or greater than the second.

Annotations

@Override