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