Top Description Fields Constructors Methods
groovy.util

public Class OrderBy<T>

extends Object
implements Comparator<T>, Serializable
Class Inheritance
All Implemented Interfaces
java.io.Serializable, java.util.Comparator
Imports
groovy.lang.Closure, org.codehaus.groovy.runtime.NumberAwareComparator, org.codehaus.groovy.runtime.typehandling.DefaultTypeTransformation, java.io.Serializable, java.util.ArrayList, .Comparator, .List
A helper class for sorting objects via a closure to return the field or operation on which to sort.

Field Summary

Modifier and TypeField and Description
private final List<Closure<V>>
closures

private boolean
equalityCheck

private final NumberAwareComparator<Object>
numberAwareComparator

private static final long
serialVersionUID

Constructor Summary

AccessConstructor and Description
public
OrderBy()

public
OrderBy(boolean equalityCheck)

public
OrderBy(Closure<V> closure)

public
OrderBy(Closure<V> closure, boolean equalityCheck)

public
OrderBy(List<Closure<V>> closures)

public
OrderBy(List<Closure<V>> closures, boolean equalityCheck)

Method Summary

Modifier and TypeMethod and Description
public void
add(Closure<V> closure)

public int
compare(T
the first object to be compared.
object1, T
the second object to be compared.
object2)

Implements java.util.Comparator.compare.

Compares its two arguments for order.
public boolean
isEqualityCheck()

public void
setEqualityCheck(boolean equalityCheck)

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

closuresback to summary
private final List<Closure<V>> closures
equalityCheckback to summary
private boolean equalityCheck
numberAwareComparatorback to summary
private final NumberAwareComparator<Object> numberAwareComparator
serialVersionUIDback to summary
private static final long serialVersionUID

Constructor Detail

OrderByback to summary
public OrderBy()
OrderByback to summary
public OrderBy(boolean equalityCheck)
OrderByback to summary
public OrderBy(Closure<V> closure)
OrderByback to summary
public OrderBy(Closure<V> closure, boolean equalityCheck)
OrderByback to summary
public OrderBy(List<Closure<V>> closures)
OrderByback to summary
public OrderBy(List<Closure<V>> closures, boolean equalityCheck)

Method Detail

addback to summary
public void add(Closure<V> closure)
compareback to summary
public int compare(T object1, T object2)

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
object1:T

the first object to be compared.

object2: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.

isEqualityCheckback to summary
public boolean isEqualityCheck()
setEqualityCheckback to summary
public void setEqualityCheck(boolean equalityCheck)