View Javadoc

1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache License, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License.  You may obtain a copy of the License at
8    *
9    *      http://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  package org.apache.commons.functor;
18  
19  /**
20   * A functor that takes one argument and returns a <code>boolean</code> value.
21   * <p>
22   * Implementors are encouraged but not required to make their functors
23   * {@link java.io.Serializable Serializable}.
24   * </p>
25   *
26   * @param <A> the argument type.
27   * @since 1.0
28   * @version $Revision: 1156740 $ $Date: 2011-08-11 21:02:40 +0200 (Thu, 11 Aug 2011) $
29   * @author Rodney Waldhoff
30   */
31  public interface UnaryPredicate<A> extends UnaryFunctor<A> {
32      /**
33       * Evaluate this predicate.
34       *
35       * @param obj the A object to test
36       * @return the result of this test
37       */
38      boolean test(A obj);
39  }