Class FindWithinGenerator<E>

java.lang.Object
org.apache.commons.functor.core.algorithm.FindWithinGenerator<E>
Type Parameters:
E - the arguments type.
All Implemented Interfaces:
Serializable, BinaryFunction<Generator<? extends E>, UnaryPredicate<? super E>, E>, BinaryFunctor<Generator<? extends E>, UnaryPredicate<? super E>>, Functor
public final class FindWithinGenerator<E> extends Object implements BinaryFunction<Generator<? extends E>, UnaryPredicate<? super E>, E>, Serializable
Return the first Object in a Generator matching a UnaryPredicate.
Version:
$Revision$ $Date$
See Also:

  • Field Details

    • INSTANCE

      public static final FindWithinGenerator<Object> INSTANCE
      Basic instance.

    • serialVersionUID

      private static final long serialVersionUID
      serialVersionUID declaration.
      See Also:

    • useIfNone

      private final boolean useIfNone
      Flag to mark the evaluate(Generator, UnaryPredicate) method must return a user defined object when the adapted procedure does not find any object.

    • ifNone

      private final E ifNone
      Object to be returned in the case the adapted procedure does not find any object.

  • Constructor Details

    • 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 Details

    • evaluate

      public E evaluate(Generator<? extends E> left, UnaryPredicate<? super E> right)
      Evaluate this function.
      Specified by:
      evaluate in interface BinaryFunction<Generator<? extends E>, UnaryPredicate<? super E>, E>
      Parameters:
      left - Generator
      right - UnaryPredicate
      Returns:
      the T result of this function for the given arguments

    • equals

      public boolean equals(Object obj)
      Indicates whether some other object is "equal to" this functor. This method must adhere to general 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.

      Specified by:
      equals in interface Functor
      Overrides:
      equals in class Object
      Parameters:
      obj - the object to compare this functor to
      Returns:
      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).
      See Also:

    • hashCode

      public int hashCode()
      Returns a hash code for this functor adhering to the general Object.hashCode contract. Implementators are strongly encouraged but not strictly required to override the default Object implementation of this method.
      Specified by:
      hashCode in interface Functor
      Overrides:
      hashCode in class Object
      Returns:
      a hash code for this functor
      See Also:

    • instance

      public static FindWithinGenerator<Object> instance()
      Get a static FindWithinGenerator instance.
      Returns:
      FindWithinGenerator