summaryrefslogtreecommitdiffstats
path: root/common/src/main/java/org/onap/so/openpojo/rules/HasEqualsAndHashCodeRule.java
blob: 351c5b0977bdffb52828c11d945909faaece4c73 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
/*-
 * ============LICENSE_START=======================================================
 * ONAP - SO
 * ================================================================================
 * Copyright (C) 2017 AT&T Intellectual Property. All rights reserved.
 * ================================================================================
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *      http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * ============LICENSE_END=========================================================
 */

package org.onap.so.openpojo.rules;

import static org.hamcrest.CoreMatchers.anyOf;
import static org.hamcrest.CoreMatchers.anything;
import java.lang.reflect.Method;
import java.lang.reflect.Parameter;
import org.hamcrest.Matcher;
import com.openpojo.reflection.PojoClass;
import com.openpojo.validation.affirm.Affirm;
import com.openpojo.validation.rule.Rule;

/**
 * This rule ensures that classes have overriden the default equals and hashCode methods from Object
 */
public class HasEqualsAndHashCodeRule implements Rule {

    private final Matcher m;

    public HasEqualsAndHashCodeRule() {
        m = anything();
    }

    public HasEqualsAndHashCodeRule(Matcher m) {
        this.m = m;
    }

    @Override
    public void evaluate(PojoClass pojoClass) {
        Class<?> clazz = pojoClass.getClazz();
        if (anyOf(m).matches(clazz)) {
            boolean hasEquals = false;
            boolean hasHashCode = false;
            final String name = clazz.getSimpleName();
            final Method[] methods;
            if (clazz.getSuperclass().equals(Object.class)) {
                methods = clazz.getDeclaredMethods();
            } else {
                methods = clazz.getMethods();
            }
            for (Method method : methods) {
                Parameter[] parameters = method.getParameters();
                if ("equals".equals(method.getName()) && boolean.class.equals(method.getReturnType())
                        && parameters.length == 1 && Object.class.equals(parameters[0].getType())) {
                    hasEquals = true;
                } else if ("hashCode".equals(method.getName()) && int.class.equals(method.getReturnType())) {
                    hasHashCode = true;
                }
            }

            if (!hasEquals) {
                Affirm.fail(String.format("[%s] does not override equals", name));
            }
            if (!hasHashCode) {
                Affirm.fail(String.format("[%s] does not override hashCode", name));
            }
        }
    }

}