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
23 /**
24 * Predicate implementation that always returns false.
25 *
26 * @param <T> the type of the input to the predicate.
27 * @since 3.0
28 */
29 public final class FalsePredicate<T> extends AbstractPredicate<T> implements Serializable {
30
31 /** Serial version UID */
32 private static final long serialVersionUID = 7533784454832764388L;
33
34 /** Singleton predicate instance */
35 @SuppressWarnings("rawtypes") // the static instance works for all types
36 public static final Predicate INSTANCE = new FalsePredicate<>();
37
38 /**
39 * Gets a typed instance.
40 *
41 * @param <T> the type that the predicate queries
42 * @return the singleton instance
43 * @since 4.0
44 */
45 public static <T> Predicate<T> falsePredicate() {
46 return INSTANCE;
47 }
48
49 /**
50 * Restricted constructor.
51 */
52 private FalsePredicate() {
53 }
54
55 /**
56 * Returns the singleton instance.
57 *
58 * @return the singleton instance.
59 */
60 private Object readResolve() {
61 return INSTANCE;
62 }
63
64 /**
65 * Evaluates the predicate returning false always.
66 *
67 * @param object the input object
68 * @return false always
69 */
70 @Override
71 public boolean test(final T object) {
72 return false;
73 }
74
75 }