Class OrderBy

src/main/java/groovy/util/OrderBy.java:35–142

A helper class for sorting objects via a closure to return the field or operation on which to sort.

 * or operation on which to sort.
 */
public class OrderBy<T> implements Comparator<T>, Serializable {

    @Serial private static final long serialVersionUID = 8385130064804116654L;
    private final List<Closure> closures;
    private boolean equalityCheck;
    private final NumberAwareComparator<Object> numberAwareComparator = new NumberAwareComparator<Object>();

    /**
     * Creates an ordering with no comparison closures.
     */
    public OrderBy() {
        this(new ArrayList<Closure>(), false);
    }

    /**
     * Creates an ordering with no comparison closures.
     *
     * @param equalityCheck whether equality-only comparison should be used for non-comparable values
     */
    public OrderBy(boolean equalityCheck) {
        this(new ArrayList<Closure>(), equalityCheck);
    }

    /**
     * Creates an ordering using a single comparison closure.
     *
     * @param closure the comparison closure
     */
    public OrderBy(Closure closure) {
        this(closure, false);
    }

    /**
     * Creates an ordering using a single comparison closure.
     *
     * @param closure the comparison closure
     * @param equalityCheck whether equality-only comparison should be used for non-comparable values
     */
    public OrderBy(Closure closure, boolean equalityCheck) {
        this(new ArrayList<Closure>(), equalityCheck);
        closures.add(closure);
    }

    /**
     * Creates an ordering using the supplied comparison closures.
     *
     * @param closures the comparison closures
     */
    public OrderBy(List<Closure> closures) {
        this(closures, false);
    }

    /**
     * Creates an ordering using the supplied comparison closures.
     *
     * @param closures the comparison closures
     * @param equalityCheck whether equality-only comparison should be used for non-comparable values
     */