1 /* 2 * Licensed to the Apache Software Foundation (ASF) under one or more 3 * contributor license agreements. See the NOTICE file distributed with 4 * this work for additional information regarding copyright ownership. 5 * The ASF licenses this file to You under the Apache License, Version 2.0 6 * (the "License"); you may not use this file except in compliance with 7 * the License. You may obtain a copy of the License at 8 * 9 * http://www.apache.org/licenses/LICENSE-2.0 10 * 11 * Unless required by applicable law or agreed to in writing, software 12 * distributed under the License is distributed on an "AS IS" BASIS, 13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 14 * See the License for the specific language governing permissions and 15 * limitations under the License. 16 */ 17 package org.apache.commons.collections4.functors; 18 19 import java.util.Collection; 20 21 import org.apache.commons.collections4.Predicate; 22 23 /** 24 * Predicate implementation that returns true if any of the 25 * predicates return true. 26 * If the array of predicates is empty, then this predicate returns false. 27 * <p> 28 * NOTE: In versions prior to 3.2 an array size of zero or one 29 * threw an exception. 30 * </p> 31 * 32 * @since 3.0 33 */ 34 public final class AnyPredicate<T> extends AbstractQuantifierPredicate<T> { 35 36 /** Serial version UID */ 37 private static final long serialVersionUID = 7429999530934647542L; 38 39 /** 40 * Factory to create the predicate. 41 * <p> 42 * If the collection is size zero, the predicate always returns false. 43 * If the collection is size one, then that predicate is returned. 44 * 45 * @param <T> the type that the predicate queries 46 * @param predicates the predicates to check, cloned, not null 47 * @return the {@code all} predicate 48 * @throws NullPointerException if the predicates array is null 49 * @throws NullPointerException if any predicate in the array is null 50 */ 51 @SuppressWarnings("unchecked") 52 public static <T> Predicate<T> anyPredicate(final Collection<? extends Predicate<? super T>> predicates) { 53 final Predicate<? super T>[] preds = FunctorUtils.validate(predicates); 54 if (preds.length == 0) { 55 return FalsePredicate.<T>falsePredicate(); 56 } 57 if (preds.length == 1) { 58 return (Predicate<T>) preds[0]; 59 } 60 return new AnyPredicate<>(preds); 61 } 62 63 /** 64 * Factory to create the predicate. 65 * <p> 66 * If the array is size zero, the predicate always returns false. 67 * If the array is size one, then that predicate is returned. 68 * 69 * @param <T> the type that the predicate queries 70 * @param predicates the predicates to check, cloned, not null 71 * @return the {@code any} predicate 72 * @throws NullPointerException if the predicates array is null 73 * @throws NullPointerException if any predicate in the array is null 74 */ 75 @SuppressWarnings("unchecked") 76 public static <T> Predicate<T> anyPredicate(final Predicate<? super T>... predicates) { 77 FunctorUtils.validate(predicates); 78 if (predicates.length == 0) { 79 return FalsePredicate.<T>falsePredicate(); 80 } 81 if (predicates.length == 1) { 82 return (Predicate<T>) predicates[0]; 83 } 84 return new AnyPredicate<>(FunctorUtils.copy(predicates)); 85 } 86 87 /** 88 * Constructor that performs no validation. 89 * Use {@code anyPredicate} if you want that. 90 * 91 * @param predicates the predicates to check, not cloned, not null 92 */ 93 public AnyPredicate(final Predicate<? super T>... predicates) { 94 super(predicates); 95 } 96 97 /** 98 * Evaluates the predicate returning true if any predicate returns true. 99 * 100 * @param object the input object 101 * @return true if any decorated predicate return true 102 */ 103 @Override 104 public boolean evaluate(final T object) { 105 for (final Predicate<? super T> iPredicate : iPredicates) { 106 if (iPredicate.evaluate(object)) { 107 return true; 108 } 109 } 110 return false; 111 } 112 113 }