ConditionalFunction (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.ConditionalFunction<T>

Type Parameters:
T - the returned value type.

All Implemented Interfaces:

Serializable, Function<T>, Functor, NullaryFunctor
```
public final class ConditionalFunction<T>
extends Object
implements Function<T>, Serializable
```
A Function similiar to Java's "ternary" or "conditional" operator (? :). Given a predicate p and functions f and g, evaluates to p.test() ? f.evaluate() : g.evaluate().
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
`ConditionalFunction(Predicate ifPred, Function<? extends T> thenFunc, Function<? extends T> elseFunc)` Create a new ConditionalFunction.

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`equals(ConditionalFunction<?> that)` Learn whether another ConditionalFunction is equal to this.
`boolean`	`equals(Object that)`
`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
  - ConditionalFunction
```
public ConditionalFunction(Predicate ifPred,
                   Function<? extends T> thenFunc,
                   Function<? extends T> elseFunc)
```
    Create a new ConditionalFunction.
    
    Parameters:
    ifPred - if
    thenFunc - then
    elseFunc - else
- Method Detail
  - evaluate
```
public T evaluate()
```
    Evaluate this function.
    
    Specified by:
    
    evaluate in interface Function<T>
    
    Returns:
    the T result of this evaluation
  - equals
```
public boolean equals(Object that)
```
    Overrides:
    
    equals in class Object
  - equals
```
public boolean equals(ConditionalFunction<?> that)
```
    Learn whether another ConditionalFunction is equal to this.
    
    Parameters:
    that - ConditionalFunction 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.