Class CompositeUnaryPredicate<A>

java.lang.Object
org.apache.commons.functor.core.composite.CompositeUnaryPredicate<A>
Type Parameters:
A - the predicate argument type.
All Implemented Interfaces:
Serializable, Functor, UnaryFunctor<A>, UnaryPredicate<A>
public final class CompositeUnaryPredicate<A> extends Object implements UnaryPredicate<A>, Serializable
A UnaryPredicate representing the composition of UnaryFunctions, "chaining" the output of one to the input of another. For example, 
new CompositeUnaryPredicate(p).of(f)
tests to p.test(f.evaluate(obj)), and 
new CompositeUnaryPredicate(p).of(f).of(g)
tests to p.test(f.evaluate(g.evaluate(obj))).

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

Version:
$Revision$ $Date$
See Also:

  • Field Details

  • Constructor Details

    • CompositeUnaryPredicate

      public CompositeUnaryPredicate(UnaryPredicate<? super A> predicate)
      Create a new CompositeUnaryPredicate.
      Parameters:
      predicate - UnaryPredicate against which the composite functions' output will be tested

    • CompositeUnaryPredicate

      private CompositeUnaryPredicate(CompositeUnaryFunction<? super A, Boolean> function)
      Create a new CompositeUnaryPredicate.
      Parameters:
      function - delegate

  • Method Details

    • of

      public <P> CompositeUnaryPredicate<P> of(UnaryFunction<? super P, ? extends A> preceding)
      Fluently obtain a CompositeUnaryPredicate that applies our predicate to the result of the preceding function.
      Type Parameters:
      P - the input function left argument and output predicate argument types
      Parameters:
      preceding - UnaryFunction
      Returns:
      CompositeUnaryPredicate

    • test

      public boolean test(A obj)
      Evaluate this predicate.
      Specified by:
      test in interface UnaryPredicate<A>
      Parameters:
      obj - the A object to test
      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(CompositeUnaryPredicate<?> that)
      Learn whether another CompositeUnaryPredicate is equal to this.
      Parameters:
      that - CompositeUnaryPredicate 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