    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 */
    017package org.apache.commons.collections4.functors;
    018
    019import java.io.Serializable;
    020import java.util.Objects;
    021
    022import org.apache.commons.collections4.Predicate;
    023
    024/**
    025 * Predicate implementation that returns true if either of the predicates return true.
    026 *
    027 * @param <T> the type of the input to the predicate.
    028 * @since 3.0
    029 */
    030public final class OrPredicate<T> extends AbstractPredicate<T> implements PredicateDecorator<T>, Serializable {
    031
    032    /** Serial version UID */
    033    private static final long serialVersionUID = -8791518325735182855L;
    034
    035    /**
    036     * Creates the predicate.
    037     *
    038     * @param <T> the type that the predicate queries
    039     * @param predicate1  the first predicate to check, not null
    040     * @param predicate2  the second predicate to check, not null
    041     * @return the {@code and} predicate
    042     * @throws NullPointerException if either predicate is null
    043     */
    044    public static <T> Predicate<T> orPredicate(final Predicate<? super T> predicate1,
    045                                               final Predicate<? super T> predicate2) {
    046        return new OrPredicate<>(Objects.requireNonNull(predicate1, "predicate1"),
    047                Objects.requireNonNull(predicate2, "predicate2"));
    048    }
    049    /** The array of predicates to call */
    050    private final Predicate<? super T> iPredicate1;
    051
    052    /** The array of predicates to call */
    053    private final Predicate<? super T> iPredicate2;
    054
    055    /**
    056     * Constructor that performs no validation.
    057     * Use {@code orPredicate} if you want that.
    058     *
    059     * @param predicate1  the first predicate to check, not null
    060     * @param predicate2  the second predicate to check, not null
    061     */
    062    public OrPredicate(final Predicate<? super T> predicate1, final Predicate<? super T> predicate2) {
    063        iPredicate1 = predicate1;
    064        iPredicate2 = predicate2;
    065    }
    066
    067    /**
    068     * Gets the two predicates being decorated as an array.
    069     *
    070     * @return the predicates
    071     * @since 3.1
    072     */
    073    @Override
    074    @SuppressWarnings("unchecked")
    075    public Predicate<? super T>[] getPredicates() {
    076        return new Predicate[] {iPredicate1, iPredicate2};
    077    }
    078
    079    /**
    080     * Evaluates the predicate returning true if either predicate returns true.
    081     *
    082     * @param object  the input object
    083     * @return true if either decorated predicate returns true
    084     */
    085    @Override
    086    public boolean test(final T object) {
    087        return iPredicate1.test(object) || iPredicate2.test(object);
    088    }
    089
    090}