Class BaseBinaryPredicateList<L,R>

java.lang.Object
org.apache.commons.functor.core.composite.BaseBinaryPredicateList<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
Direct Known Subclasses:
BinaryAnd, BinaryOr
abstract class BaseBinaryPredicateList<L,R> extends Object implements BinaryPredicate<L,R>, Serializable
Abstract base class for BinaryPredicates composed of a list of BinaryPredicates.

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$

  • Field Details

    • serialVersionUID

      private static final long serialVersionUID
      serialVersionUID declaration.
      See Also:

    • list

      private final List<BinaryPredicate<? super L, ? super R>> list
      A list to maintain all the adapted predicates.

  • Constructor Details

    • BaseBinaryPredicateList

      protected BaseBinaryPredicateList()
      Create a new BaseBinaryPredicateList.

    • BaseBinaryPredicateList

      protected BaseBinaryPredicateList(BinaryPredicate<? super L, ? super R>... predicates)
      Create a new BaseBinaryPredicateList instance.
      Parameters:
      predicates - to add

    • BaseBinaryPredicateList

      protected BaseBinaryPredicateList(Iterable<BinaryPredicate<? super L, ? super R>> predicates)
      Create a new BaseBinaryPredicateList instance.
      Parameters:
      predicates - to add

  • Method Details

    • equals

      public abstract 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:

    • hashCode

      public abstract 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 abstract 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

    • addBinaryPredicate

      protected void addBinaryPredicate(BinaryPredicate<? super L, ? super R> p)
      Add a BinaryPredicate to the list.
      Parameters:
      p - BinaryPredicate to add

    • getBinaryPredicateList

      protected List<BinaryPredicate<? super L, ? super R>> getBinaryPredicateList()
      Get the "live" list of contained BinaryPredicate instances.
      Returns:
      List

    • getBinaryPredicateListEquals

      protected boolean getBinaryPredicateListEquals(BaseBinaryPredicateList<?,?> that)
      Learn whether another list is equal to this one.
      Parameters:
      that - BaseBinaryPredicateList to test
      Returns:
      boolean

    • getBinaryPredicateListHashCode

      protected int getBinaryPredicateListHashCode()
      Get a hashCode for the list.
      Returns:
      int

    • getBinaryPredicateListToString

      protected String getBinaryPredicateListToString()
      Get a toString for the list.
      Returns:
      String