Tue, 21 May 2013 13:50:56 +0100
8005207: test has 2 @bug tags
Reviewed-by: mcimadamore
aoqi@0 | 1 | /* |
aoqi@0 | 2 | * Copyright (c) 2010, 2011, Oracle and/or its affiliates. All rights reserved. |
aoqi@0 | 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
aoqi@0 | 4 | * |
aoqi@0 | 5 | * This code is free software; you can redistribute it and/or modify it |
aoqi@0 | 6 | * under the terms of the GNU General Public License version 2 only, as |
aoqi@0 | 7 | * published by the Free Software Foundation. Oracle designates this |
aoqi@0 | 8 | * particular file as subject to the "Classpath" exception as provided |
aoqi@0 | 9 | * by Oracle in the LICENSE file that accompanied this code. |
aoqi@0 | 10 | * |
aoqi@0 | 11 | * This code is distributed in the hope that it will be useful, but WITHOUT |
aoqi@0 | 12 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
aoqi@0 | 13 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
aoqi@0 | 14 | * version 2 for more details (a copy is included in the LICENSE file that |
aoqi@0 | 15 | * accompanied this code). |
aoqi@0 | 16 | * |
aoqi@0 | 17 | * You should have received a copy of the GNU General Public License version |
aoqi@0 | 18 | * 2 along with this work; if not, write to the Free Software Foundation, |
aoqi@0 | 19 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
aoqi@0 | 20 | * |
aoqi@0 | 21 | * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
aoqi@0 | 22 | * or visit www.oracle.com if you need additional information or have any |
aoqi@0 | 23 | * questions. |
aoqi@0 | 24 | */ |
aoqi@0 | 25 | |
aoqi@0 | 26 | /** |
aoqi@0 | 27 | * Determines if the input object matches some criteria. |
aoqi@0 | 28 | * |
aoqi@0 | 29 | * <p>All predicate implementations are expected to: |
aoqi@0 | 30 | * <ul> |
aoqi@0 | 31 | * <li>Provide stable results such that for any {@code t} the result of two |
aoqi@0 | 32 | * {@code eval} operations are always equivalent. ie.<pre> |
aoqi@0 | 33 | * boolean one = predicate.test(a); |
aoqi@0 | 34 | * boolean two = predicate.test(a); |
aoqi@0 | 35 | * |
aoqi@0 | 36 | * assert one == two; |
aoqi@0 | 37 | * </pre></li> |
aoqi@0 | 38 | * <li>Equivalent input objects should map to equivalent output objects. ie.<pre> |
aoqi@0 | 39 | * assert a.equals(b); // a and b are equivalent |
aoqi@0 | 40 | * |
aoqi@0 | 41 | * boolean x = predicate.test(a); |
aoqi@0 | 42 | * boolean y = predicate.test(ab; |
aoqi@0 | 43 | * |
aoqi@0 | 44 | * assert x == y; // their test results should be the same. |
aoqi@0 | 45 | * </pre></li> |
aoqi@0 | 46 | * <li>The predicate should not modify the input object in any way that would |
aoqi@0 | 47 | * change the evaluation.</li> |
aoqi@0 | 48 | * <li>When used for aggregate operations upon many elements predicates |
aoqi@0 | 49 | * should not assume that the {@code test} operation will be called upon |
aoqi@0 | 50 | * elements in any specific order.</li> |
aoqi@0 | 51 | * </ul> |
aoqi@0 | 52 | * |
aoqi@0 | 53 | * @param <T> the type of input objects provided to {@code test}. |
aoqi@0 | 54 | */ |
aoqi@0 | 55 | public interface TPredicate<T> { |
aoqi@0 | 56 | |
aoqi@0 | 57 | /** |
aoqi@0 | 58 | * Return {@code true} if the input object matches some criteria. |
aoqi@0 | 59 | * |
aoqi@0 | 60 | * @param t the input object. |
aoqi@0 | 61 | * @return {@code true} if the input object matched some criteria. |
aoqi@0 | 62 | */ |
aoqi@0 | 63 | boolean test(T t); |
aoqi@0 | 64 | } |