IsEquivalent (Apache Commons Functor 1.0-SNAPSHOT API)

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

Type Parameters:
T - the binary predicate input types

All Implemented Interfaces:

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

Version:

$Revision: 1537901 $ $Date: 2013-11-01 12:30:19 +0100 (Fr, 01 Nov 2013) $

See Also:
IsEqual

Field Summary

Fields
Modifier and Type Field and Description

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

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

Constructor Summary

Constructors
Constructor and Description
`IsEquivalent()` Create a new IsEquivalent.
`IsEquivalent(Comparator<? super T> comparator)` Construct an `IsEquivalent` `predicate` for the given `Comparator`.

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`int`	`hashCode()`
`static <T extends Comparable<?>> IsEquivalent<T>`	`instance()` Get a basic IsEquivalent instance.
`static <T extends Comparable<?>> Predicate<T>`	`instance(T right)` Get an IsEquivalent instance that always compares to `arg`.
`boolean`	`test(T left, T right)` Return `true` iff the left parameter is equal to 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 IsEquivalent<Comparable<?>> INSTANCE
```
    Basic IsEquivalent instance.
- Constructor Detail
  - IsEquivalent
```
public IsEquivalent()
```
    Create a new IsEquivalent.
  - IsEquivalent
```
public IsEquivalent(Comparator<? super T> comparator)
```
    Construct an IsEquivalent 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 equal to 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 obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - instance
```
public static <T extends Comparable<?>> IsEquivalent<T> instance()
```
    Get a basic IsEquivalent instance.
    
    Type Parameters:
    T - the binary predicate input types
    
    Returns:
    IsEquivalent
  - instance
```
public static <T extends Comparable<?>> Predicate<T> instance(T right)
```
    Get an IsEquivalent instance that always compares to arg.
    
    Type Parameters:
    T - the predicate input type
    Parameters:
    right - argument
    
    Returns:
    Predicate

Class IsEquivalent<T>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

INSTANCE

Constructor Detail

IsEquivalent

IsEquivalent

Method Detail

test

equals

hashCode

toString

instance

instance