FindWithinGenerator (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.algorithm.FindWithinGenerator<E>

Type Parameters:
E - the arguments type.

All Implemented Interfaces:

BinaryFunction<Generator<? extends E>,Predicate<? super E>,E>, BinaryFunctor<Generator<? extends E>,Predicate<? super E>>, Functor
```
public final class FindWithinGenerator<E>
extends Object
implements BinaryFunction<Generator<? extends E>,Predicate<? super E>,E>
```
Return the first Object in a Generator matching a Predicate.

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 FindWithinGenerator<Object> INSTANCE
Basic instance.

Constructor Summary

Constructors
Constructor and Description

FindWithinGenerator()
Create a new FindWithinGenerator.

FindWithinGenerator(E ifNone)
Create a new FindWithinGenerator.

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`E`	`evaluate(Generator<? extends E> left, Predicate<? super E> right)` Evaluate this function.
`int`	`hashCode()`
`static FindWithinGenerator<Object>`	`instance()` Get a static `FindWithinGenerator` instance.
`String`	`toString()`

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

- Field Detail
  - INSTANCE
```
public static final FindWithinGenerator<Object> INSTANCE
```
    Basic instance.
- Constructor Detail
  - FindWithinGenerator
```
public FindWithinGenerator()
```
    Create a new FindWithinGenerator.
  - FindWithinGenerator
```
public FindWithinGenerator(E ifNone)
```
    Create a new FindWithinGenerator.
    
    Parameters:
    ifNone - object to return if the Generator contains no matches.
- Method Detail
  - evaluate
```
public E evaluate(Generator<? extends E> left,
         Predicate<? super E> right)
```
    Evaluate this function.
    
    Specified by:
    
    evaluate in interface BinaryFunction<Generator<? extends E>,Predicate<? super E>,E>
    
    Parameters:
    left - Generator
    right - Predicate
    
    Returns:
    the T result of this function for the given arguments
  - 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
  - instance
```
public static FindWithinGenerator<Object> instance()
```
    Get a static FindWithinGenerator instance.
    
    Returns:
    FindWithinGenerator

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

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