Class ConditionalBinaryProcedure<L,R>

java.lang.Object
org.apache.commons.functor.core.composite.ConditionalBinaryProcedure<L,R>
Type Parameters:
L - the left argument type.
R - the right argument type.
All Implemented Interfaces:
Serializable, BinaryFunctor<L,R>, BinaryProcedure<L,R>, Functor
public final class ConditionalBinaryProcedure<L,R> extends Object implements BinaryProcedure<L,R>, Serializable
A BinaryProcedure similiar to Java's "ternary" or "conditional" operator (? :). Given a predicate p and procedures q and r, runs if (p.test(x,y)) { q.run(x,y); } else { r.run(x,y); }.

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

    • serialVersionUID

      private static final long serialVersionUID
      serialVersionUID declaration.
      See Also:

    • HASH_SHIFT

      private static final int HASH_SHIFT
      Base hash integer used to shift hash.
      See Also:

    • ifPred

      private final BinaryPredicate<? super L, ? super R> ifPred
      the condition to be evaluated.

    • thenProc

      private final BinaryProcedure<? super L, ? super R> thenProc
      the predicate executed if the condition is satisfied.

    • elseProc

      private final BinaryProcedure<? super L, ? super R> elseProc
      the predicate executed if the condition is not satisfied.

  • Constructor Details

    • ConditionalBinaryProcedure

      public ConditionalBinaryProcedure(BinaryPredicate<? super L, ? super R> ifPred, BinaryProcedure<? super L, ? super R> thenProc)
      Create a new ConditionalBinaryProcedure.
      Parameters:
      ifPred - to evaluate
      thenProc - if ifPred yields true

    • ConditionalBinaryProcedure

      public ConditionalBinaryProcedure(BinaryPredicate<? super L, ? super R> ifPred, BinaryProcedure<? super L, ? super R> thenProc, BinaryProcedure<? super L, ? super R> elseProc)
      Create a new ConditionalBinaryProcedure.
      Parameters:
      ifPred - to evaluate
      thenProc - if ifPred yields true
      elseProc - if ifPred yields false

  • Method Details

    • run

      public void run(L left, R right)
      Execute this procedure.
      Specified by:
      run in interface BinaryProcedure<L,R>
      Parameters:
      left - the L element of the ordered pair of arguments
      right - the R element of the ordered pair of arguments

    • 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(ConditionalBinaryProcedure<?,?> that)
      Learn whether a given ConditionalBinaryProcedure is equal to this.
      Parameters:
      that - compared object
      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