001    /*
002     *  Licensed to the Apache Software Foundation (ASF) under one or more
003     *  contributor license agreements.  See the NOTICE file distributed with
004     *  this work for additional information regarding copyright ownership.
005     *  The ASF licenses this file to You under the Apache License, Version 2.0
006     *  (the "License"); you may not use this file except in compliance with
007     *  the License.  You may obtain a copy of the License at
008     *
009     *      http://www.apache.org/licenses/LICENSE-2.0
010     *
011     *  Unless required by applicable law or agreed to in writing, software
012     *  distributed under the License is distributed on an "AS IS" BASIS,
013     *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014     *  See the License for the specific language governing permissions and
015     *  limitations under the License.
016     */
017    package org.apache.commons.collections.functors;
018    
019    import java.io.Serializable;
020    
021    import org.apache.commons.collections.Predicate;
022    
023    /**
024     * Predicate implementation that returns true if either of the predicates return true.
025     * 
026     * @since Commons Collections 3.0
027     * @version $Revision: 646777 $ $Date: 2008-04-10 13:33:15 +0100 (Thu, 10 Apr 2008) $
028     *
029     * @author Stephen Colebourne
030     */
031    public final class OrPredicate implements Predicate, PredicateDecorator, Serializable {
032    
033        /** Serial version UID */
034        private static final long serialVersionUID = -8791518325735182855L;
035        
036        /** The array of predicates to call */
037        private final Predicate iPredicate1;
038        /** The array of predicates to call */
039        private final Predicate iPredicate2;
040        
041        /**
042         * Factory to create the predicate.
043         * 
044         * @param predicate1  the first predicate to check, not null
045         * @param predicate2  the second predicate to check, not null
046         * @return the <code>and</code> predicate
047         * @throws IllegalArgumentException if either predicate is null
048         */
049        public static Predicate getInstance(Predicate predicate1, Predicate predicate2) {
050            if (predicate1 == null || predicate2 == null) {
051                throw new IllegalArgumentException("Predicate must not be null");
052            }
053            return new OrPredicate(predicate1, predicate2);
054        }
055    
056        /**
057         * Constructor that performs no validation.
058         * Use <code>getInstance</code> if you want that.
059         * 
060         * @param predicate1  the first predicate to check, not null
061         * @param predicate2  the second predicate to check, not null
062         */
063        public OrPredicate(Predicate predicate1, Predicate predicate2) {
064            super();
065            iPredicate1 = predicate1;
066            iPredicate2 = predicate2;
067        }
068    
069        /**
070         * Evaluates the predicate returning true if either predicate returns true.
071         * 
072         * @param object  the input object
073         * @return true if either decorated predicate returns true
074         */
075        public boolean evaluate(Object object) {
076           return (iPredicate1.evaluate(object) || iPredicate2.evaluate(object));
077        }
078    
079        /**
080         * Gets the two predicates being decorated as an array.
081         * 
082         * @return the predicates
083         * @since Commons Collections 3.1
084         */
085        public Predicate[] getPredicates() {
086            return new Predicate[] {iPredicate1, iPredicate2};
087        }
088    
089    }