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 int} input value matches some criteria. This is the
  31  * {@code int}-consuming primitive type specialization of {@link Predicate}.
  32  *
  33  * @see Predicate
  34  * @since 1.8
  35  */
  36 @FunctionalInterface
  37 public interface IntPredicate {
  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 value matches some criteria, otherwise
  44      * {@code false}
  45      */
  46     boolean test(int 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      * @param p a predicate which will be logically-ANDed with this predicate
  55      * @return a new predicate which returns {@code true} only if both
  56      * predicates return {@code true}
  57      * @throws NullPointerException if p is null
  58      */
  59     default IntPredicate and(IntPredicate p) {
  60         Objects.requireNonNull(p);
  61         return (value) -> test(value) && p.test(value);
  62     }
  63 
  64     /**
  65      * Returns a predicate which negates the result of this predicate.
  66      *
  67      * @return a new predicate who's result is always the opposite of this
  68      * predicate
  69      */
  70     default IntPredicate negate() {
  71         return (value) -> !test(value);
  72     }
  73 
  74     /**
  75      * Returns a predicate which evaluates to {@code true} if either this
  76      * predicate or the provided predicate evaluates to {@code true}. If this
  77      * predicate returns {@code true} then the remaining predicate is not
  78      * evaluated.
  79      *
  80      * @param p a predicate which will be logically-ORed with this predicate
  81      * @return a new predicate which returns {@code true} if either predicate
  82      * returns {@code true}
  83      * @throws NullPointerException if p is null
  84      */
  85     default IntPredicate or(IntPredicate p) {
  86         Objects.requireNonNull(p);
  87         return (value) -> test(value) || p.test(value);
  88     }
  89 }