Class IsElementOf<L,R>

java.lang.Object
org.apache.commons.functor.core.collection.IsElementOf<L,R>
Type Parameters:
L - the left argument type.
R - the right argument type.
All Implemented Interfaces:
Serializable, BinaryFunctor<L,R>, BinaryPredicate<L,R>, Functor
public final class IsElementOf<L,R> extends Object implements BinaryPredicate<L,R>, Serializable
A BinaryPredicate that checks to see if the specified object is an element of the specified Collection.
Since:
1.0
Version:
$Revision$ $Date$
See Also:

  • Field Details

  • Constructor Details

    • IsElementOf

      public IsElementOf()
      Create a new IsElementOf.

  • Method Details

    • test

      public boolean test(L obj, R col)
      Evaluate this predicate.
      Specified by:
      test in interface BinaryPredicate<L,R>
      Parameters:
      obj - the L element of the ordered pair of arguments
      col - the R element of the ordered pair of arguments
      Returns:
      the result of this test 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:

    • toString

      public String toString()
      Returns a human readable description of this functor. Implementators are strongly encouraged but not strictly required to override the default Object implementation of this method.
      Specified by:
      toString in interface Functor
      Overrides:
      toString in class Object
      Returns:
      a human readable description of this functor

    • testCollection

      private boolean testCollection(Object obj, Collection<?> col)
      Test a collection.
      Parameters:
      obj - to find
      col - to search
      Returns:
      boolean

    • testArray

      private boolean testArray(Object obj, Object array)
      Test an array.
      Parameters:
      obj - to find
      array - to search
      Returns:
      boolean

    • instance

      public static IsElementOf<Object,Object> instance()
      Get an IsElementOf instance.
      Returns:
      IsElementOf

    • instance

      public static <A> UnaryPredicate<A> instance(Object obj)
      Get an IsElementOf(collection|array) UnaryPredicate.
      Type Parameters:
      A - the UnaryPredicate argument generic type
      Parameters:
      obj - collection/array to search
      Returns:
      UnaryPredicate