Spring Core 6.1.4 · org.springframework.util.comparator.ComparableComparator

public Class ComparableComparator<T extends java.lang.Comparable<T>>

extends Object
implements Comparator<T extends Comparable<T>>

Class Inheritance

java.lang.Object
org.springframework.util.comparator.ComparableComparator

All Implemented Interfaces

java.util.Comparator

Annotations

@Deprecated
since:6.1

Type Parameters

<T>: the type of comparable objects that may be compared by this comparator

Imports

java.util.Comparator

Deprecated

since 6.1.

as of 6.1 in favor of Comparator#naturalOrder()

Comparator that adapts Comparables to the Comparator interface. Mainly for internal use in other Comparators, when supposed to work on Comparables.

Author

Keith Donald

Since

1.2.2

Field Summary

Modifier and Type	Field and Description
public static final ComparableComparator<T extends Comparable<T>>	INSTANCE A shared instance of this default comparator.

Constructor Summary

Access	Constructor and Description
public	ComparableComparator()

Method Summary

Modifier and Type	Method and Description
public int	compare(T the first object to be compared. o1, T the second object to be compared. o2) 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

Field Detail

INSTANCE	back to summary
public static final ComparableComparator<T extends Comparable<T>> INSTANCE Deprecated as a consequence of `ComparableComparator` being deprecated. See corresponding docs for further information. A shared instance of this default comparator. Annotations @SuppressWarnings:rawtypes See Also `Comparators#comparable()`

Constructor Detail

ComparableComparator	back to summary
public ComparableComparator()

Method Detail

compare back to summary

compare	back to summary
public int compare(T o1, T o2) 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 o1:T the first object to be compared. o2: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(T o1, T o2)

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

o1:T: the first object to be compared.
o2: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