Class RetainMatching<T>

java.lang.Object
org.apache.commons.functor.core.algorithm.RetainMatching<T>
Type Parameters:
T - the procedure argument type
All Implemented Interfaces:
Serializable, BinaryFunctor<Iterator<? extends T>, UnaryPredicate<? super T>>, BinaryProcedure<Iterator<? extends T>, UnaryPredicate<? super T>>, Functor
public final class RetainMatching<T> extends Object implements BinaryProcedure<Iterator<? extends T>, UnaryPredicate<? super T>>, Serializable
Retain elements in left Iterator that match right UnaryPredicate.
Version:
$Revision$ $Date$
See Also:

  • Field Details

    • serialVersionUID

      private static final long serialVersionUID
      serialVersionUID declaration.
      See Also:

    • INSTANCE

      private static final RetainMatching<Object> INSTANCE
      A static RetainMatching instance reference.

    • removeMatching

      private final RemoveMatching<T> removeMatching
      The RemoveMatching instance used to remove elements from input iterator.

  • Constructor Details

    • RetainMatching

      public RetainMatching()

  • Method Details

    • run

      public void run(Iterator<? extends T> left, UnaryPredicate<? super T> right)
      Execute this procedure.
      Specified by:
      run in interface BinaryProcedure<Iterator<? extends T>, UnaryPredicate<? super T>>
      Parameters:
      left - Iterator
      right - UnaryPredicate

    • 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 RetainMatching<Object> instance()
      Get a static RetainMatching instance.
      Returns:
      RetainMatching