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

Class UnaryOr<A>

  • Type Parameters:
    A - the predicate argument type.
    All Implemented Interfaces:
    java.io.Serializable, Functor, UnaryFunctor<A>, UnaryPredicate<A>
    public final class UnaryOr<A>
extends BaseUnaryPredicateList<A>
    Tests true iff at least one of its children test true. Note that by this definition, the "or" of an empty collection of predicates tests false.

    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

      • UnaryOr

        public UnaryOr()
        Create a new UnaryOr.

      • UnaryOr

        public UnaryOr​(java.lang.Iterable<UnaryPredicate<? super A>> predicates)
        Create a new UnaryOr instance.
        Parameters:
        predicates - the predicates to put in unary or.

      • UnaryOr

        public UnaryOr​(UnaryPredicate<? super A>... predicates)
        Create a new UnaryOr instance.
        Parameters:
        predicates - the predicates to put in unary or.

    • Method Detail

      • or

        public UnaryOr<A> or​(UnaryPredicate<? super A> p)
        Fluently add a Predicate.
        Parameters:
        p - Predicate to add
        Returns:
        this

      • test

        public boolean test​(A a)
        Evaluate this predicate.
        Parameters:
        a - the A object to test
        Returns:
        the result of this test

      • 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 BaseUnaryPredicateList<A>
        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​(UnaryOr<?> that)
        Learn whether another UnaryOr is equal to this.
        Parameters:
        that - UnaryOr 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 BaseUnaryPredicateList<A>
        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 BaseUnaryPredicateList<A>
        Returns:
        a human readable description of this functor