Class FunctionPredicate

java.lang.Object
org.apache.commons.functor.adapter.FunctionPredicate
All Implemented Interfaces:
Serializable, Functor, NullaryFunctor, Predicate
public final class FunctionPredicate extends Object implements Predicate, Serializable
Adapts a Boolean-valued Function to the Predicate interface.

Note that although this class implements Serializable, a given instance will only be truly Serializable if the underlying functor is. Attempts to serialize an instance whose delegate is not Serializable will result in an exception.

Version:
$Revision$ $Date$
See Also:

  • Field Details

  • Constructor Details

    • FunctionPredicate

      public FunctionPredicate(Function<Boolean> function)
      Create a new FunctionPredicate.
      Parameters:
      function - to adapt

  • Method Details

    • test

      public boolean test()
      Returns the boolean value of the non-null Boolean returned by the evaluate method of my underlying function. Evaluate this predicate.
      Specified by:
      test in interface Predicate
      Returns:
      the result of this test

    • equals

      public boolean equals(Object that)
      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:
      that - 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:

    • equals

      public boolean equals(FunctionPredicate that)
      Learn whether another FunctionPredicate is equal to this.
      Parameters:
      that - FunctionPredicate to test
      Returns:
      boolean

    • 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

    • adapt

      public static FunctionPredicate adapt(Function<Boolean> function)
      Adapt a Function as a Predicate.
      Parameters:
      function - to adapt
      Returns:
      FunctionPredicate