Top Description Inners Fields Constructors Methods
org.eclipse.collections.api.block.factory

public final Class SerializableComparators

extends Object
Class Inheritance
Imports
org.eclipse.collections.api.block.SerializableComparator, org.eclipse.collections.api.block.comparator.FunctionComparator, org.eclipse.collections.api.block.function.Function

This class provides a minimal set of SerializableComparator methods for use in the API module.
Since
11.1

Nested and Inner Type Summary

Modifier and TypeClass and Description
private static class
private static class

Field Summary

Modifier and TypeField and Description
private static final SerializableComparator<?>
private static final SerializableComparator<?>

Constructor Summary

AccessConstructor and Description
private

Method Summary

Modifier and TypeMethod and Description
public static <T, V extends Comparable<? super V>> SerializableComparator<T>
byFunction(Function<? super T, ? extends V> function)

public static <T, V> SerializableComparator<T>
byFunction(Function<? super T, ? extends V> function, SerializableComparator<V> comparator)

public static <T> SerializableComparator<T>
naturalOrder()

Uses the natural compareTo methods of the objects which will throw if there are any nulls.

public static <T> SerializableComparator<T>

Returns:

A comparator that reverses the order of any other Serializable Comparator.
reverse
(SerializableComparator<T>
original comparator whose order will be reversed
comparator
)

public static <T> SerializableComparator<T>
reverseNaturalOrder()

Uses the natural compareTo methods of the objects which will throw if there are any nulls.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

NATURAL_ORDER_COMPARATORback to summary
private static final SerializableComparator<?> NATURAL_ORDER_COMPARATOR
REVERSE_NATURAL_ORDER_COMPARATORback to summary
private static final SerializableComparator<?> REVERSE_NATURAL_ORDER_COMPARATOR

Constructor Detail

SerializableComparatorsback to summary
private SerializableComparators()

Method Detail

byFunctionback to summary
public static <T, V extends Comparable<? super V>> SerializableComparator<T> byFunction(Function<? super T, ? extends V> function)
byFunctionback to summary
public static <T, V> SerializableComparator<T> byFunction(Function<? super T, ? extends V> function, SerializableComparator<V> comparator)
naturalOrderback to summary
public static <T> SerializableComparator<T> naturalOrder()

Uses the natural compareTo methods of the objects which will throw if there are any nulls.

reverseback to summary
public static <T> SerializableComparator<T> reverse(SerializableComparator<T> comparator)
Parameters
comparator:SerializableComparator<T>

original comparator whose order will be reversed

Returns:SerializableComparator<T>

A comparator that reverses the order of any other Serializable Comparator.

reverseNaturalOrderback to summary
public static <T> SerializableComparator<T> reverseNaturalOrder()

Uses the natural compareTo methods of the objects which will throw if there are any nulls.

org.eclipse.collections.api.block.factory back to summary

private final Class SerializableComparators.NaturalOrderComparator<T extends Comparable<T>>

extends Object
implements SerializableComparator<T extends Comparable<T>>
Class Inheritance
  • java.lang.Object
  • org.eclipse.collections.api.block.factory.SerializableComparators.NaturalOrderComparator
All Implemented Interfaces
org.eclipse.collections.api.block.SerializableComparator, java.io.Serializable, java.util.Comparator

Field Summary

Modifier and TypeField and Description
private static final long

Constructor Summary

AccessConstructor and Description
private

Method Summary

Modifier and TypeMethod 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:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

serialVersionUIDback to summary
private static final long serialVersionUID

Constructor Detail

NaturalOrderComparatorback to summary
private NaturalOrderComparator()

Method Detail

compareback 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
org.eclipse.collections.api.block.factory back to summary

private final Class SerializableComparators.ReverseComparator<T>

extends Object
implements SerializableComparator<T>
Class Inheritance
  • java.lang.Object
  • org.eclipse.collections.api.block.factory.SerializableComparators.ReverseComparator
All Implemented Interfaces
org.eclipse.collections.api.block.SerializableComparator, java.io.Serializable, java.util.Comparator

Field Summary

Modifier and TypeField and Description
private final SerializableComparator<T>
private static final long

Constructor Summary

AccessConstructor and Description
private

Method Summary

Modifier and TypeMethod 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:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

comparatorback to summary
private final SerializableComparator<T> comparator
serialVersionUIDback to summary
private static final long serialVersionUID

Constructor Detail

ReverseComparatorback to summary
private ReverseComparator(SerializableComparator<T> comparator)

Method Detail

compareback 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