| /* |
| * Copyright (c) 2010, 2013, Oracle and/or its affiliates. All rights reserved. |
| * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
| * |
| * This code is free software; you can redistribute it and/or modify it |
| * under the terms of the GNU General Public License version 2 only, as |
| * published by the Free Software Foundation. Oracle designates this |
| * particular file as subject to the "Classpath" exception as provided |
| * by Oracle in the LICENSE file that accompanied this code. |
| * |
| * This code is distributed in the hope that it will be useful, but WITHOUT |
| * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
| * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
| * version 2 for more details (a copy is included in the LICENSE file that |
| * accompanied this code). |
| * |
| * You should have received a copy of the GNU General Public License version |
| * 2 along with this work; if not, write to the Free Software Foundation, |
| * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
| * |
| * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
| * or visit www.oracle.com if you need additional information or have any |
| * questions. |
| */ |
| package java.util.function; |
| |
| import java.util.Objects; |
| |
| /** |
| * Represents a predicate (boolean-valued function) of one {@code int}-valued |
| * argument. This is the {@code int}-consuming primitive type specialization of |
| * {@link Predicate}. |
| * |
| * <p>This is a <a href="package-summary.html">functional interface</a> |
| * whose functional method is {@link #test(int)}. |
| * |
| * @see Predicate |
| * @since 1.8 |
| */ |
| @FunctionalInterface |
| public interface IntPredicate { |
| |
| /** |
| * Evaluates this predicate on the given argument. |
| * |
| * @param value the input argument |
| * @return {@code true} if the input argument matches the predicate, |
| * otherwise {@code false} |
| */ |
| boolean test(int value); |
| |
| /** |
| * Returns a composed predicate that represents a short-circuiting logical |
| * AND of this predicate and another. When evaluating the composed |
| * predicate, if this predicate is {@code false}, then the {@code other} |
| * predicate is not evaluated. |
| * |
| * <p>Any exceptions thrown during evaluation of either predicate are relayed |
| * to the caller; if evaluation of this predicate throws an exception, the |
| * {@code other} predicate will not be evaluated. |
| * |
| * @param other a predicate that will be logically-ANDed with this |
| * predicate |
| * @return a composed predicate that represents the short-circuiting logical |
| * AND of this predicate and the {@code other} predicate |
| * @throws NullPointerException if other is null |
| */ |
| default IntPredicate and(IntPredicate other) { |
| Objects.requireNonNull(other); |
| return (value) -> test(value) && other.test(value); |
| } |
| |
| /** |
| * Returns a predicate that represents the logical negation of this |
| * predicate. |
| * |
| * @return a predicate that represents the logical negation of this |
| * predicate |
| */ |
| default IntPredicate negate() { |
| return (value) -> !test(value); |
| } |
| |
| /** |
| * Returns a composed predicate that represents a short-circuiting logical |
| * OR of this predicate and another. When evaluating the composed |
| * predicate, if this predicate is {@code true}, then the {@code other} |
| * predicate is not evaluated. |
| * |
| * <p>Any exceptions thrown during evaluation of either predicate are relayed |
| * to the caller; if evaluation of this predicate throws an exception, the |
| * {@code other} predicate will not be evaluated. |
| * |
| * @param other a predicate that will be logically-ORed with this |
| * predicate |
| * @return a composed predicate that represents the short-circuiting logical |
| * OR of this predicate and the {@code other} predicate |
| * @throws NullPointerException if other is null |
| */ |
| default IntPredicate or(IntPredicate other) { |
| Objects.requireNonNull(other); |
| return (value) -> test(value) || other.test(value); |
| } |
| } |