1 /* 2 * Copyright (c) 2010, 2012 Oracle and/or its affiliates. All rights reserved. 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4 * 5 * This code is free software; you can redistribute it and/or modify it 6 * under the terms of the GNU General Public License version 2 only, as 7 * published by the Free Software Foundation. Oracle designates this 8 * particular file as subject to the "Classpath" exception as provided 9 * by Oracle in the LICENSE file that accompanied this code. 10 * 11 * This code is distributed in the hope that it will be useful, but WITHOUT 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 14 * version 2 for more details (a copy is included in the LICENSE file that 15 * accompanied this code). 16 * 17 * You should have received a copy of the GNU General Public License version 18 * 2 along with this work; if not, write to the Free Software Foundation, 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 20 * 21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA 22 * or visit www.oracle.com if you need additional information or have any 23 * questions. 24 */ 25 package java.util.function; 26 27 import java.util.Objects; 28 29 /** 30 * Determines if the {@code long} input value matches some criteria. 31 * 32 * <p>This is the primitive type specialization of {@link Predicate} for 33 * {@code double} and also may be used as a {@code Predicate<Double>}. 34 * 35 * @since 1.8 36 */ 37 public interface DoublePredicate { 38 39 /** 40 * Returns {@code true} if the input value matches some criteria. 41 * 42 * @param value the value to be tested. 43 * @return {@code true} if the input object matches some criteria, otherwise 44 * {@code false} 45 */ 46 public boolean test(double value); 47 48 /** 49 * Returns a predicate which evaluates to {@code true} only if this 50 * predicate and the provided predicate both evaluate to {@code true}. If 51 * this predicate returns {@code false} then the remaining predicate is not 52 * evaluated. 53 * 54 * @return a new predicate which returns {@code true} only if both 55 * predicates return {@code true}. 56 */ 57 public default DoublePredicate and(DoublePredicate p) { 58 Objects.requireNonNull(p); 59 return (double t) -> test(t) && p.test(t); 60 } 61 62 /** 63 * Returns a predicate which negates the result of this predicate. 64 * 65 * @return a new predicate who's result is always the opposite of this 66 * predicate. 67 */ 68 public default DoublePredicate negate() { 69 return (double t) -> !test(t); 70 } 71 72 /** 73 * Returns a predicate which evaluates to {@code true} if either this 74 * predicate or the provided predicate evaluates to {@code true}. If this 75 * predicate returns {@code true} then the remaining predicate is not 76 * evaluated. 77 * 78 * @return a new predicate which returns {@code true} if either predicate 79 * returns {@code true}. 80 */ 81 public default DoublePredicate or(DoublePredicate p) { 82 Objects.requireNonNull(p); 83 return (double t) -> test(t) || p.test(t); 84 } 85 86 /** 87 * Returns a predicate that evaluates to {@code true} if all or none of the 88 * component predicates evaluate to {@code true}. 89 * 90 * @return a predicate that evaluates to {@code true} if all or none of the 91 * component predicates evaluate to {@code true} 92 */ 93 public default DoublePredicate xor(DoublePredicate p) { 94 Objects.requireNonNull(p); 95 return (double t) -> test(t) ^ p.test(t); 96 } 97 }