|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.commons.functor.core.algorithm.FindWithinGenerator<E>
E
- the arguments type.public final class FindWithinGenerator<E>
Return the first Object in a Generator
matching a UnaryPredicate
.
Field Summary | |
---|---|
static FindWithinGenerator<Object> |
INSTANCE
Basic instance. |
Constructor Summary | |
---|---|
FindWithinGenerator()
Create a new FindWithinGenerator. |
|
FindWithinGenerator(E ifNone)
Create a new FindWithinGenerator. |
Method Summary | |
---|---|
boolean |
equals(Object obj)
Indicates whether some other object is "equal to" this functor. |
E |
evaluate(Generator<? extends E> left,
UnaryPredicate<? super E> right)
Evaluate this function. |
int |
hashCode()
Returns a hash code for this functor adhering to the general Object.hashCode contract. |
static FindWithinGenerator<Object> |
instance()
Get a static FindWithinGenerator instance. |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface org.apache.commons.functor.Functor |
---|
toString |
Field Detail |
---|
public static final FindWithinGenerator<Object> INSTANCE
Constructor Detail |
---|
public FindWithinGenerator()
public FindWithinGenerator(E ifNone)
ifNone
- object to return if the Generator contains no matches.Method Detail |
---|
public E evaluate(Generator<? extends E> left, UnaryPredicate<? super E> right)
evaluate
in interface BinaryFunction<Generator<? extends E>,UnaryPredicate<? super E>,E>
left
- Generatorright
- UnaryPredicate
public boolean equals(Object obj)
Object.equals
contract.
Additionally, this method can return
true only if the specified Object implements
the same functor interface and is known to produce the same
results and/or side-effects for the same arguments (if any).
While implementators are strongly encouraged to override
the default Object implementation of this method,
note that the default Object implementation
does in fact adhere to the functor equals
contract.
equals
in interface Functor
equals
in class Object
obj
- the object to compare this functor to
true
iff the given object implements
this functor interface, and is known to produce the same
results and/or side-effects for the same arguments
(if any).Functor.hashCode()
public int hashCode()
Object.hashCode
contract.
Implementators are strongly encouraged but not
strictly required to override the default Object
implementation of this method.
hashCode
in interface Functor
hashCode
in class Object
Functor.equals(java.lang.Object)
public static FindWithinGenerator<Object> instance()
FindWithinGenerator
instance.
FindWithinGenerator
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |