src/java/org/apache/commons/functor/core/composite/BasePredicateList.java

/*
 * Copyright 2003,2004 The Apache Software Foundation.
 * 
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *      http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.commons.functor.core.composite;

import java.io.Serializable;
import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;

import org.apache.commons.functor.Predicate;

/**
 * Abstract base class for {@link Predicate Predicates}
 * composed of a list of {@link Predicate Predicates}.
 * <p>
 * Note that although this class implements 
 * {@link Serializable}, a given instance will
 * only be truly <code>Serializable</code> if all the
 * underlying functors are.  Attempts to serialize
 * an instance whose delegates are not all 
 * <code>Serializable</code> will result in an exception.
 * </p>
 * @version $Revision$ $Date$
 * @author Rodney Waldhoff
 */
abstract class BasePredicateList implements Predicate, Serializable {

    // constructor
    // ------------------------------------------------------------------------
    protected BasePredicateList() {
    }

    protected BasePredicateList(Predicate p) {
        addPredicate(p);
    }

    protected BasePredicateList(Predicate p, Predicate q) {
        addPredicate(p);
        addPredicate(q);
    }

    protected BasePredicateList(Predicate p, Predicate q, Predicate r) {
        addPredicate(p);
        addPredicate(q);
        addPredicate(r);
    }
    
    // abstract
    // ------------------------------------------------------------------------ 
    public abstract boolean equals(Object that);
    public abstract int hashCode();
    public abstract String toString();
    public abstract boolean test();

    // modifiers
    // ------------------------------------------------------------------------ 
    protected void addPredicate(Predicate p) {
        list.add(p);
    }
 
    // protected
    // ------------------------------------------------------------------------

    protected Iterator getPredicateIterator() {
        return list.iterator();
    }
    
    protected boolean getPredicateListEquals(BasePredicateList that) {
        return (null != that && this.list.equals(that.list));
    }
    
    protected int getPredicateListHashCode() {
        return list.hashCode();
    }
    
    protected String getPredicateListToString() {
        return String.valueOf(list);
    }
    
    // attributes
    // ------------------------------------------------------------------------
    private List list = new ArrayList();

}