< prev index next >

src/java.base/share/classes/java/util/function/Predicate.java

Print this page




   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  * Represents a predicate (boolean-valued function) of one argument.
  31  *
  32  * <p>This is a <a href="package-summary.html">functional interface</a>
  33  * whose functional method is {@link #test(Object)}.
  34  *
  35  * @param <T> the type of the input to the predicate
  36  *
  37  * @since 1.8
  38  */
  39 @FunctionalInterface
  40 public interface Predicate<T> {
  41 
  42     /**
  43      * Evaluates this predicate on the given argument.
  44      *
  45      * @param t the input argument
  46      * @return {@code true} if the input argument matches the predicate,
  47      * otherwise {@code false}
  48      */
  49     boolean test(T t);
  50 
  51     /**
  52      * Returns a composed predicate that represents a short-circuiting logical
  53      * AND of this predicate and another.  When evaluating the composed
  54      * predicate, if this predicate is {@code false}, then the {@code other}
  55      * predicate is not evaluated.
  56      *
  57      * <p>Any exceptions thrown during evaluation of either predicate are relayed
  58      * to the caller; if evaluation of this predicate throws an exception, the
  59      * {@code other} predicate will not be evaluated.
  60      *




   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 javany.util.function;
  26 
  27 import java.util.Objects;
  28 
  29 /**
  30  * Represents a predicate (boolean-valued function) of one argument.
  31  *
  32  * <p>This is a <a href="package-summary.html">functional interface</a>
  33  * whose functional method is {@link #test(Object)}.
  34  *
  35  * @param <T> the type of the input to the predicate
  36  *
  37  * @since 1.8
  38  */
  39 @FunctionalInterface
  40 public interface Predicate<any T> {
  41 
  42     /**
  43      * Evaluates this predicate on the given argument.
  44      *
  45      * @param t the input argument
  46      * @return {@code true} if the input argument matches the predicate,
  47      * otherwise {@code false}
  48      */
  49     boolean test(T t);
  50 
  51     /**
  52      * Returns a composed predicate that represents a short-circuiting logical
  53      * AND of this predicate and another.  When evaluating the composed
  54      * predicate, if this predicate is {@code false}, then the {@code other}
  55      * predicate is not evaluated.
  56      *
  57      * <p>Any exceptions thrown during evaluation of either predicate are relayed
  58      * to the caller; if evaluation of this predicate throws an exception, the
  59      * {@code other} predicate will not be evaluated.
  60      *


< prev index next >