org.eclipse.collections.api.block.comparator

public Class FunctionComparator<T, V>

Class Inheritance

extends Object
implements SerializableComparator<T>

java.lang.Object
org.eclipse.collections.api.block.comparator.FunctionComparator

All Implemented Interfaces

org.eclipse.collections.api.block.SerializableComparator, java.io.Serializable, java.util.Comparator

Imports

org.eclipse.collections.api.block.SerializableComparator, org.eclipse.collections.api.block.function.Function

Field Summary

Modifier and Type	Field and Description
private final SerializableComparator<V>	comparator
private final Function<? super T, ? extends V>	function
private static final long	serialVersionUID

Constructor Summary

Access	Constructor and Description
public	FunctionComparator(Function<? super T, ? extends V> function, SerializableComparator<V> comparator)

Method Summary

Modifier and Type	Method and Description
public int	compare(T o1, T 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

comparator	back to summary
private final SerializableComparator<V> comparator

function	back to summary
private final Function<? super T, ? extends V> function

serialVersionUID	back to summary
private static final long serialVersionUID

Constructor Detail

FunctionComparator	back to summary
public FunctionComparator(Function<? super T, ? extends V> function, SerializableComparator<V> comparator)

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`. 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.

Annotations

@Override