ConditionalBinaryFunction (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.composite.ConditionalBinaryFunction<L,R,T>

Type Parameters:
L - the left argument type.
R - the right argument type.
T - the output function returned value type.

All Implemented Interfaces:

Serializable, BinaryFunction<L,R,T>, BinaryFunctor<L,R>, Functor
```
public final class ConditionalBinaryFunction<L,R,T>
extends Object
implements BinaryFunction<L,R,T>, Serializable
```
A BinaryFunction similiar to Java's "ternary" or "conditional" operator (? :). Given a predicate p and functions f and g, evaluates to p.test(x,y) ? f.evaluate(x,y) : g.evaluate(x,y).
Note that although this class implements Serializable, a given instance will only be truly Serializable if all the underlying functors are. Attempts to serialize an instance whose delegates are not all Serializable will result in an exception.

Version:

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

See Also:
Serialized Form

Constructor Summary

Constructors
Constructor and Description
`ConditionalBinaryFunction(BinaryPredicate<? super L,? super R> ifPred, BinaryFunction<? super L,? super R,? extends T> thenFunc, BinaryFunction<? super L,? super R,? extends T> elseFunc)` Create a new ConditionalBinaryFunction.

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`equals(ConditionalBinaryFunction<?,?,?> that)` Learn whether another ConditionalBinaryFunction is equal to this.
`boolean`	`equals(Object that)`
`T`	`evaluate(L left, R right)` Evaluate this function.
`int`	`hashCode()`
`String`	`toString()`

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

- Constructor Detail
  - ConditionalBinaryFunction
```
public ConditionalBinaryFunction(BinaryPredicate<? super L,? super R> ifPred,
                         BinaryFunction<? super L,? super R,? extends T> thenFunc,
                         BinaryFunction<? super L,? super R,? extends T> elseFunc)
```
    Create a new ConditionalBinaryFunction.
    
    Parameters:
    ifPred - if
    thenFunc - then
    elseFunc - else
- Method Detail
  - evaluate
```
public T evaluate(L left,
         R right)
```
    Evaluate this function.
    
    Specified by:
    
    evaluate in interface BinaryFunction<L,R,T>
    
    Parameters:
    left - the L element of the ordered pair of arguments
    right - the R element of the ordered pair of arguments
    
    Returns:
    the T result of this function for the given arguments
  - equals
```
public boolean equals(Object that)
```
    Overrides:
    
    equals in class Object
  - equals
```
public boolean equals(ConditionalBinaryFunction<?,?,?> that)
```
    Learn whether another ConditionalBinaryFunction is equal to this.
    
    Parameters:
    that - ConditionalBinaryFunction to test
    
    Returns:
    boolean
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

Copyright © 2003-2013 The Apache Software Foundation. All Rights Reserved.