Package org.apache.commons.functor.core.composite

Class BinaryAnd<L,​R>

  • Type Parameters:
    L - the left argument type.
    R - the right argument type.
    All Implemented Interfaces:
    java.io.Serializable, BinaryFunctor<L,​R>, BinaryPredicate<L,​R>, Functor
    public final class BinaryAnd<L,​R>
extends BaseBinaryPredicateList<L,​R>
    Tests true iff none of its children test false. Note that by this definition, the "and" of an empty collection of predicates tests true.

    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:
    Serialized Form

    • Field Detail

      • serialVersionUID

        private static final long serialVersionUID
        serialVersionUID declaration.
        See Also:
        Constant Field Values

    • Constructor Detail

      • BinaryAnd

        public BinaryAnd()
        Create a new BinaryAnd.

      • BinaryAnd

        public BinaryAnd​(BinaryPredicate<? super L,​? super R>... predicates)
        Create a new BinaryAnd instance.
        Parameters:
        predicates - the predicates to add

      • BinaryAnd

        public BinaryAnd​(java.lang.Iterable<BinaryPredicate<? super L,​? super R>> predicates)
        Create a new BinaryAnd instance.
        Parameters:
        predicates - the predicates to add

    • Method Detail

      • and

        public BinaryAnd<L,​R> and​(BinaryPredicate<? super L,​? super R> p)
        And in a BinaryPredicate.
        Parameters:
        p - BinaryPredicate to add
        Returns:
        this

      • test

        public boolean test​(L a,
                    R b)
        Evaluate this predicate.
        Parameters:
        a - the L element of the ordered pair of arguments
        b - the R element of the ordered pair of arguments
        Returns:
        the result of this test for the given arguments

      • equals

        public boolean equals​(java.lang.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
        Specified by:
        equals in class BaseBinaryPredicateList<L,​R>
        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:
        Functor.hashCode()

      • equals

        public boolean equals​(BinaryAnd<?,​?> that)
        Learn whether another BinaryAnd is equal to this.
        Parameters:
        that - the BinaryAnd 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
        Specified by:
        hashCode in class BaseBinaryPredicateList<L,​R>
        Returns:
        a hash code for this functor
        See Also:
        Functor.equals(java.lang.Object)

      • toString

        public java.lang.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
        Specified by:
        toString in class BaseBinaryPredicateList<L,​R>
        Returns:
        a human readable description of this functor