BoundPredicate (Commons Functor 1.0-SNAPSHOT API)

java.lang.Object
- org.apache.commons.functor.adapter.BoundPredicate

All Implemented Interfaces:

Serializable, Functor, NullaryFunctor, Predicate
```
public final class BoundPredicate
extends Object
implements Predicate, Serializable
```
Adapts a UnaryPredicate to the Predicate interface using a constant unary argument.
Note that although this class implements Serializable, a given instance will only be truly Serializable if the underlying objects are. Attempts to serialize an instance whose delegates are not Serializable will result in an exception.

Version:

$Revision: 1365377 $ $Date: 2012-07-24 20:59:23 -0400 (Tue, 24 Jul 2012) $

See Also:
Serialized Form

Constructor Summary

Constructors
Constructor and Description

BoundPredicate(UnaryPredicate<? super A> predicate, A arg)
Create a new BoundPredicate instance.

Constructors
Constructor and Description
`BoundPredicate(UnaryPredicate<? super A> predicate, A arg)` Create a new BoundPredicate instance.

Method Summary

Methods
Modifier and Type	Method and Description
`static <A> BoundPredicate`	`bind(UnaryPredicate<? super A> predicate, A arg)` Adapt the given, possibly-`null`, `UnaryPredicate` to the `Predicate` interface by binding the specified `Object` as a constant argument.
`boolean`	`equals(BoundPredicate that)` Learn whether another BoundPredicate is equal to this.
`boolean`	`equals(Object that)`
`int`	`hashCode()`
`boolean`	`test()` Evaluate this predicate.
`String`	`toString()`

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

- Constructor Detail
  - BoundPredicate
```
public BoundPredicate(UnaryPredicate<? super A> predicate,
              A arg)
```
    Create a new BoundPredicate instance.
    
    Type Parameters:
    A - input type
    Parameters:
    predicate - the predicate to adapt
    arg - the constant argument to use
- Method Detail
  - test
```
public boolean test()
```
    Evaluate this predicate.
    
    Specified by:
    
    test in interface Predicate
    
    Returns:
    the result of this test
  - equals
```
public boolean equals(Object that)
```
    Overrides:
    
    equals in class Object
  - equals
```
public boolean equals(BoundPredicate that)
```
    Learn whether another BoundPredicate is equal to this.
    
    Parameters:
    that - BoundPredicate to test
    
    Returns:
    boolean
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - bind
```
public static <A> BoundPredicate bind(UnaryPredicate<? super A> predicate,
                      A arg)
```
    Adapt the given, possibly-null, UnaryPredicate to the Predicate interface by binding the specified Object as a constant argument. When the given UnaryPredicate is null, returns null.
    
    Type Parameters:
    A - input type
    Parameters:
    predicate - the possibly-null UnaryPredicate to adapt
    arg - the object to bind as a constant argument
    
    Returns:
    a BoundPredicate wrapping the given UnaryPredicate, or null if the given UnaryPredicate is null

Class BoundPredicate

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BoundPredicate

Method Detail

test

equals

equals

hashCode

toString

bind