IsGreaterThan (Commons Functor 1.0-SNAPSHOT API)

java.lang.Object
- org.apache.commons.functor.core.comparator.IsGreaterThan<T>

Type Parameters:
T - the binary predicate input types

All Implemented Interfaces:

Serializable, BinaryFunctor<T,T>, BinaryPredicate<T,T>, Functor
```
public final class IsGreaterThan<T>
extends Object
implements BinaryPredicate<T,T>, Serializable
```
A BinaryPredicate that tests true iff the left argument is greater than the right argument under the specified Comparator. When no (or a null Comparator is specified, a Comparable Comparator is used.

Version:

$Revision: 1365328 $ $Date: 2012-07-24 18:19:23 -0400 (Tue, 24 Jul 2012) $

See Also:
Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

static IsGreaterThan<Comparable<?>> INSTANCE
Basic IsGreaterThan instance.

Fields
Modifier and Type	Field and Description
`static IsGreaterThan<Comparable<?>>`	`INSTANCE` Basic IsGreaterThan instance.

Constructor Summary

Constructors
Constructor and Description
`IsGreaterThan()` Construct a `IsGreaterThan` `predicate` for `Comparable`s.
`IsGreaterThan(Comparator<? super T> comparator)` Construct a `IsGreaterThan` `predicate` for the given `Comparator`.

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`equals(IsGreaterThan<?> that)` Learn whether a given IsGreaterThan is equal to this.
`boolean`	`equals(Object that)`
`int`	`hashCode()`
`static <T extends Comparable<?>> IsGreaterThan<T>`	`instance()` Get a typed IsGreaterThan instance.
`static <T extends Comparable<?>> UnaryPredicate<T>`	`instance(T right)` Get an IsGreaterThan UnaryPredicate.
`boolean`	`test(T left, T right)` Return `true` iff the left parameter is greater than the right parameter under my current `Comparator`.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - INSTANCE
```
public static final IsGreaterThan<Comparable<?>> INSTANCE
```
    Basic IsGreaterThan instance.
- Constructor Detail
  - IsGreaterThan
```
public IsGreaterThan()
```
    Construct a IsGreaterThan predicate for Comparables.
  - IsGreaterThan
```
public IsGreaterThan(Comparator<? super T> comparator)
```
    Construct a IsGreaterThan predicate for the given Comparator.
    
    Parameters:
    comparator - the Comparator, when null, a Comparator for Comparables will be used.
- Method Detail
  - test
```
public boolean test(T left,
           T right)
```
    Return true iff the left parameter is greater than the right parameter under my current Comparator. Evaluate this predicate.
    
    Specified by:
    
    test in interface BinaryPredicate<T,T>
    
    Parameters:
    left - the L element of the ordered pair of arguments
    right - the R element of the ordered pair of arguments
    
    Returns:
    the result of this test for the given arguments
  - equals
```
public boolean equals(Object that)
```
    Overrides:
    
    equals in class Object
  - equals
```
public boolean equals(IsGreaterThan<?> that)
```
    Learn whether a given IsGreaterThan is equal to this.
    
    Parameters:
    that - the IsGreaterThan to test
    
    Returns:
    boolean
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - instance
```
public static <T extends Comparable<?>> IsGreaterThan<T> instance()
```
    Get a typed IsGreaterThan instance.
    
    Type Parameters:
    T - the binary predicate input types
    
    Returns:
    IsGreaterThan
  - instance
```
public static <T extends Comparable<?>> UnaryPredicate<T> instance(T right)
```
    Get an IsGreaterThan UnaryPredicate.
    
    Type Parameters:
    T - the binary predicate input types
    Parameters:
    right - the right side object of the IsGreaterThan comparison
    
    Returns:
    UnaryPredicate

Class IsGreaterThan<T>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

INSTANCE

Constructor Detail

IsGreaterThan

IsGreaterThan

Method Detail

test

equals

equals

hashCode

toString

instance

instance