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 true if the input is an instanceof
26 * the type stored in this predicate.
27 *
28 * @since 3.0
29 */
30 public final class InstanceofPredicate implements Predicate<Object>, Serializable {
31
32 /** Serial version UID */
33 private static final long serialVersionUID = -6682656911025165584L;
34
35 /**
36 * Factory to create the identity predicate.
37 *
38 * @param type the type to check for, may not be null
39 * @return the predicate
40 * @throws NullPointerException if the class is null
41 */
42 public static Predicate<Object> instanceOfPredicate(final Class<?> type) {
43 return new InstanceofPredicate(Objects.requireNonNull(type, "type"));
44 }
45
46 /** The type to compare to */
47 private final Class<?> iType;
48
49 /**
50 * Constructor that performs no validation.
51 * Use {@code instanceOfPredicate} if you want that.
52 *
53 * @param type the type to check for
54 */
55 public InstanceofPredicate(final Class<?> type) {
56 iType = type;
57 }
58
59 /**
60 * Evaluates the predicate returning true if the input object is of the correct type.
61 *
62 * @param object the input object
63 * @return true if input is of stored type
64 */
65 @Override
66 public boolean evaluate(final Object object) {
67 return iType.isInstance(object);
68 }
69
70 /**
71 * Gets the type to compare to.
72 *
73 * @return the type
74 * @since 3.1
75 */
76 public Class<?> getType() {
77 return iType;
78 }
79
80 }