Tue, 21 May 2013 13:50:56 +0100
8005207: test has 2 @bug tags
Reviewed-by: mcimadamore
1 /*
2 * Copyright (c) 2010, 2011, 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 */
26 /**
27 * Determines if the input object matches some criteria.
28 *
29 * <p>All predicate implementations are expected to:
30 * <ul>
31 * <li>Provide stable results such that for any {@code t} the result of two
32 * {@code eval} operations are always equivalent. ie.<pre>
33 * boolean one = predicate.test(a);
34 * boolean two = predicate.test(a);
35 *
36 * assert one == two;
37 * </pre></li>
38 * <li>Equivalent input objects should map to equivalent output objects. ie.<pre>
39 * assert a.equals(b); // a and b are equivalent
40 *
41 * boolean x = predicate.test(a);
42 * boolean y = predicate.test(ab;
43 *
44 * assert x == y; // their test results should be the same.
45 * </pre></li>
46 * <li>The predicate should not modify the input object in any way that would
47 * change the evaluation.</li>
48 * <li>When used for aggregate operations upon many elements predicates
49 * should not assume that the {@code test} operation will be called upon
50 * elements in any specific order.</li>
51 * </ul>
52 *
53 * @param <T> the type of input objects provided to {@code test}.
54 */
55 public interface TPredicate<T> {
57 /**
58 * Return {@code true} if the input object matches some criteria.
59 *
60 * @param t the input object.
61 * @return {@code true} if the input object matched some criteria.
62 */
63 boolean test(T t);
64 }