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 import java.util.Objects;
21
22 import org.apache.commons.collections4.Predicate;
23
24 /**
25 * Predicate implementation that returns the opposite of the decorated predicate.
26 *
27 * @since 3.0
28 */
29 public final class NotPredicate<T> implements PredicateDecorator<T>, Serializable {
30
31 /** Serial version UID */
32 private static final long serialVersionUID = -2654603322338049674L;
33
34 /**
35 * Factory to create the not predicate.
36 *
37 * @param <T> the type that the predicate queries
38 * @param predicate the predicate to decorate, not null
39 * @return the predicate
40 * @throws NullPointerException if the predicate is null
41 */
42 public static <T> Predicate<T> notPredicate(final Predicate<? super T> predicate) {
43 return new NotPredicate<>(Objects.requireNonNull(predicate, "predicate"));
44 }
45
46 /** The predicate to decorate */
47 private final Predicate<? super T> iPredicate;
48
49 /**
50 * Constructor that performs no validation.
51 * Use {@code notPredicate} if you want that.
52 *
53 * @param predicate the predicate to call after the null check
54 */
55 public NotPredicate(final Predicate<? super T> predicate) {
56 iPredicate = predicate;
57 }
58
59 /**
60 * Evaluates the predicate returning the opposite to the stored predicate.
61 *
62 * @param object the input object
63 * @return true if predicate returns false
64 */
65 @Override
66 public boolean evaluate(final T object) {
67 return !iPredicate.evaluate(object);
68 }
69
70 /**
71 * Gets the predicate being decorated.
72 *
73 * @return the predicate as the only element in an array
74 * @since 3.1
75 */
76 @Override
77 @SuppressWarnings("unchecked")
78 public Predicate<? super T>[] getPredicates() {
79 return new Predicate[] {iPredicate};
80 }
81
82 }