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

Class BasePredicateList

  • All Implemented Interfaces:
    java.io.Serializable, Functor, NullaryFunctor, Predicate
    Direct Known Subclasses:
    And, Or
    abstract class BasePredicateList
extends java.lang.Object
implements Predicate, java.io.Serializable
    Abstract base class for Predicates composed of a list of Predicates.

    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 Summary

      Fields 
      Modifier and Type Field Description
      private java.util.List<Predicate> list
      A list where storing the adapted predicates.
      private static long serialVersionUID
      serialVersionUID declaration.

    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      protected BasePredicateList()
      Create a new BasePredicateList instance.
      protected BasePredicateList​(java.lang.Iterable<Predicate> predicates)
      Create a new BasePredicateList instance.
      protected BasePredicateList​(Predicate... predicates)
      Create a new BasePredicateList instance.

    • Field Detail

      • serialVersionUID

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

      • list

        private final java.util.List<Predicate> list
        A list where storing the adapted predicates.

    • Constructor Detail

      • BasePredicateList

        protected BasePredicateList()
        Create a new BasePredicateList instance.

      • BasePredicateList

        protected BasePredicateList​(Predicate... predicates)
        Create a new BasePredicateList instance.
        Parameters:
        predicates - to add

      • BasePredicateList

        protected BasePredicateList​(java.lang.Iterable<Predicate> predicates)
        Create a new BasePredicateList instance.
        Parameters:
        predicates - to add

    • Method Detail

      • equals

        public abstract 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
        Overrides:
        equals in class java.lang.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:
        Functor.hashCode()

      • 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 java.lang.Object
        Returns:
        a hash code for this functor
        See Also:
        Functor.equals(java.lang.Object)

      • toString

        public abstract 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
        Overrides:
        toString in class java.lang.Object
        Returns:
        a human readable description of this functor

      • addPredicate

        protected void addPredicate​(Predicate p)
        Add a Predicate to the list.
        Parameters:
        p - Predicate to add

      • getPredicateList

        protected java.util.List<Predicate> getPredicateList()
        Get the "live" list of Predicates.
        Returns:
        List

      • getPredicateListEquals

        protected boolean getPredicateListEquals​(BasePredicateList that)
        Learn whether the list of another BasePredicateList is equal to my list.
        Parameters:
        that - BasePredicateList to test
        Returns:
        boolean

      • getPredicateListHashCode

        protected int getPredicateListHashCode()
        Get a hashCode for my list.
        Returns:
        int

      • getPredicateListToString

        protected java.lang.String getPredicateListToString()
        Get a toString for my list.
        Returns:
        String