IsEqual (Apache Commons Functor 1.0-SNAPSHOT API)

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

java.lang.Object
- org.apache.commons.functor.core.IsEqual<L,R>

Type Parameters:
L - the left argument type.
R - the right argument type.

All Implemented Interfaces:

BinaryFunctor<L,R>, BinaryPredicate<L,R>, Functor
```
public final class IsEqual<L,R>
extends Object
implements BinaryPredicate<L,R>
```
Tests true iff its arguments are equal or both null.
This relation is an equivalence relation on the set of objects that adhere to the Object.equals contract.

Version:

$Revision: 1537906 $ $Date: 2013-11-01 12:47:33 +0100 (Fr, 01 Nov 2013) $

Field Summary

Fields
Modifier and Type Field and Description

static IsEqual<Object,Object> INSTANCE
Basic IsEqual instance.

Constructor Summary

Constructors
Constructor and Description

IsEqual()
Create a new IsEqual.

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object that)`
`int`	`hashCode()`
`static <L,R> IsEqual<L,R>`	`instance()` Get an IsEqual instance.
`boolean`	`test(L left, R right)` Evaluate this predicate.
`static <L,R> Predicate<L>`	`to(R object)` Get an IsEqual Predicate.
`String`	`toString()`

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

- Field Detail
  - INSTANCE
```
public static final IsEqual<Object,Object> INSTANCE
```
    Basic IsEqual instance.
- Constructor Detail
  - IsEqual
```
public IsEqual()
```
    Create a new IsEqual.
- Method Detail
  - test
```
public boolean test(L left,
           R right)
```
    Evaluate this predicate.
    
    Specified by:
    
    test in interface BinaryPredicate<L,R>
    
    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
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - instance
```
public static <L,R> IsEqual<L,R> instance()
```
    Get an IsEqual instance.
    
    Type Parameters:
    L - the left argument type.
    R - the right argument type.
    
    Returns:
    IsEqual
  - to
```
public static <L,R> Predicate<L> to(R object)
```
    Get an IsEqual Predicate.
    
    Type Parameters:
    L - the left argument type.
    R - the right argument type.
    Parameters:
    object - bound comparison object
    
    Returns:
    Predicate

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

Copyright © 2003–2014 The Apache Software Foundation. All rights reserved.