1 /*
   2  * Copyright (c) 2010, 2013, 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 double} input value matches some criteria. This is
  31  * the {@code double}-consuming primitive type specialization of
  32  * {@link Predicate}.
  33  *
  34  * @see Predicate
  35  * @since 1.8
  36  */
  37 @FunctionalInterface
  38 public interface DoublePredicate {
  39 
  40     /**
  41      * Returns {@code true} if the input value matches some criteria.
  42      *
  43      * @param value the value to be tested
  44      * @return {@code true} if the input value matches some criteria, otherwise
  45      * {@code false}
  46      */
  47     boolean test(double value);
  48 
  49     /**
  50      * Returns a predicate which evaluates to {@code true} only if this
  51      * predicate and the provided predicate both evaluate to {@code true}. If
  52      * this predicate returns {@code false} then the remaining predicate is not
  53      * evaluated.
  54      *
  55      * <p>Any exceptions thrown by either {@code test} method are relayed
  56      * to the caller; if performing first operation throws an exception, the
  57      * second operation will not be performed.
  58      *
  59      * @param p a predicate which will be logically-ANDed with this predicate
  60      * @return a new predicate which returns {@code true} only if both
  61      * predicates return {@code true}
  62      * @throws NullPointerException if p is null
  63      */
  64     default DoublePredicate and(DoublePredicate p) {
  65         Objects.requireNonNull(p);
  66         return (value) -> test(value) && p.test(value);
  67     }
  68 
  69     /**
  70      * Returns a predicate which negates the result of this predicate.
  71      *
  72      * @return a new predicate who's result is always the opposite of this
  73      * predicate
  74      */
  75     default DoublePredicate negate() {
  76         return (value) -> !test(value);
  77     }
  78 
  79     /**
  80      * Returns a predicate which evaluates to {@code true} if either this
  81      * predicate or the provided predicate evaluates to {@code true}. If this
  82      * predicate returns {@code true} then the remaining predicate is not
  83      * evaluated.
  84      *
  85      * <p>Any exceptions thrown by either {@code test} method are relayed
  86      * to the caller; if performing first operation throws an exception, the
  87      * second operation will not be performed.
  88      *
  89      * @param p a predicate which will be logically-ANDed with this predicate
  90      * @return a new predicate which returns {@code true} if either predicate
  91      * returns {@code true}
  92      * @throws NullPointerException if p is null
  93      */
  94     default DoublePredicate or(DoublePredicate p) {
  95         Objects.requireNonNull(p);
  96         return (value) -> test(value) || p.test(value);
  97     }
  98 }