BoundNullaryFunction (Apache Commons Functor 1.0-SNAPSHOT API)

java.lang.Object
- org.apache.commons.functor.adapter.BoundNullaryFunction<T>

Type Parameters:
T - the returned value type.

All Implemented Interfaces:

Functor, NullaryFunction<T>, NullaryFunctor
```
public final class BoundNullaryFunction<T>
extends Object
implements NullaryFunction<T>
```
Adapts a Function to the NullaryFunction interface using a constant unary argument.

Version:

$Revision: 1345136 $ $Date: 2012-06-01 09:47:06 -0300 (Fri, 01 Jun 2012) $

Constructor Summary

Constructors
Constructor and Description
`BoundNullaryFunction(Function<? super A,? extends T> function, A arg)` Create a new BoundNullaryFunction instance.

Method Summary

Methods
Modifier and Type	Method and Description
`static <A,T> BoundNullaryFunction<T>`	`bind(Function<? super A,? extends T> function, A arg)` Adapt the given, possibly-`null`, `Function` to the `NullaryFunction` interface by binding the specified `Object` as a constant argument.
`boolean`	`equals(Object obj)`
`T`	`evaluate()` Evaluate this function.
`int`	`hashCode()`
`String`	`toString()`

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

- Constructor Detail
  - BoundNullaryFunction
```
public BoundNullaryFunction(Function<? super A,? extends T> function,
                    A arg)
```
    Create a new BoundNullaryFunction instance.
    
    Type Parameters:
    A - the argument value type
    Parameters:
    function - the function to adapt
    arg - the constant argument to use
- Method Detail
  - evaluate
```
public T evaluate()
```
    Evaluate this function.
    
    Specified by:
    
    evaluate in interface NullaryFunction<T>
    
    Returns:
    the T result of this evaluation
  - 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
  - bind
```
public static <A,T> BoundNullaryFunction<T> bind(Function<? super A,? extends T> function,
                                 A arg)
```
    Adapt the given, possibly-null, Function to the NullaryFunction interface by binding the specified Object as a constant argument. When the given Function is null, returns null.
    
    Type Parameters:
    A - input type
    T - result type
    Parameters:
    function - the possibly-null Function to adapt
    arg - the object to bind as a constant argument
    
    Returns:
    a BoundNullaryFunction wrapping the given Function, or null if the given Function is null

Class BoundNullaryFunction<T>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BoundNullaryFunction

Method Detail

evaluate

equals

hashCode

toString

bind