    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 *      https://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 both the predicates return true.
    026 *
    027 * @param <T> The type of the input to the predicate.
    028 * @since 3.0
    029 */
    030public final class AndPredicate<T> extends AbstractPredicate<T> implements PredicateDecorator<T>, Serializable {
    031
    032    /** Serial version UID */
    033    private static final long serialVersionUID = 4189014213763186912L;
    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> andPredicate(final Predicate<? super T> predicate1,
    045            final Predicate<? super T> predicate2) {
    046        return new AndPredicate<>(Objects.requireNonNull(predicate1, "predicate1"),
    047                Objects.requireNonNull(predicate2, "predicate2"));
    048    }
    049
    050    /** The array of predicates to call */
    051    private final Predicate<? super T> iPredicate1;
    052
    053    /** The array of predicates to call */
    054    private final Predicate<? super T> iPredicate2;
    055
    056    /**
    057     * Constructor that performs no validation.
    058     * Use {@code andPredicate} 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 AndPredicate(final Predicate<? super T> predicate1, final Predicate<? super T> predicate2) {
    064        iPredicate1 = predicate1;
    065        iPredicate2 = predicate2;
    066    }
    067
    068    /**
    069     * Gets the two predicates being decorated as an array.
    070     *
    071     * @return The predicates
    072     * @since 3.1
    073     */
    074    @Override
    075    @SuppressWarnings("unchecked")
    076    public Predicate<? super T>[] getPredicates() {
    077        return new Predicate[] {iPredicate1, iPredicate2};
    078    }
    079
    080    /**
    081     * Evaluates the predicate returning true if both predicates return true.
    082     *
    083     * @param object  The input object
    084     * @return true if both decorated predicates return true
    085     */
    086    @Override
    087    public boolean test(final T object) {
    088        return iPredicate1.test(object) && iPredicate2.test(object);
    089    }
    090
    091}