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.collections4.functors;
18
19 import java.io.Serializable;
20
21 import org.apache.commons.collections4.Predicate;
22 import org.apache.commons.collections4.Transformer;
23
24 /**
25 * Transformer implementation that calls a Predicate using the input object
26 * and then returns the result.
27 *
28 * @param <T> the type of the input and result to the function.
29 * @since 3.0
30 */
31 public class PredicateTransformer<T> implements Transformer<T, Boolean>, Serializable {
32
33 /** Serial version UID */
34 private static final long serialVersionUID = 5278818408044349346L;
35
36 /**
37 * Factory method that performs validation.
38 *
39 * @param <T> the input type
40 * @param predicate the predicate to call, not null
41 * @return the {@code predicate} transformer
42 * @throws IllegalArgumentException if the predicate is null
43 */
44 public static <T> Transformer<T, Boolean> predicateTransformer(final Predicate<? super T> predicate) {
45 if (predicate == null) {
46 throw new IllegalArgumentException("Predicate must not be null");
47 }
48 return new PredicateTransformer<>(predicate);
49 }
50
51 /** The closure to wrap */
52 private final Predicate<? super T> iPredicate;
53
54 /**
55 * Constructor that performs no validation.
56 * Use {@code predicateTransformer} if you want that.
57 *
58 * @param predicate the predicate to call, not null
59 */
60 public PredicateTransformer(final Predicate<? super T> predicate) {
61 iPredicate = predicate;
62 }
63
64 /**
65 * Gets the predicate.
66 *
67 * @return the predicate
68 * @since 3.1
69 */
70 public Predicate<? super T> getPredicate() {
71 return iPredicate;
72 }
73
74 /**
75 * Transforms the input to result by calling a predicate.
76 *
77 * @param input the input object to transform
78 * @return the transformed result
79 */
80 @Override
81 public Boolean transform(final T input) {
82 return Boolean.valueOf(iPredicate.test(input));
83 }
84
85 }