common/src/main/java/org/onap/so/openpojo/rules/HasToStringRule.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * ONAP - SO
   4  * ================================================================================
   5  * Copyright (C) 2017 AT&T Intellectual Property. All rights reserved.
   6  * ================================================================================
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  *      http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  * ============LICENSE_END=========================================================
  19  */
  20
  21 package org.onap.so.openpojo.rules;
  22
  23 import static org.hamcrest.CoreMatchers.anyOf;
  24 import static org.hamcrest.CoreMatchers.anything;
  25 import java.lang.reflect.Method;
  26 import java.lang.reflect.Parameter;
  27 import org.hamcrest.Matcher;
  28 import com.openpojo.reflection.PojoClass;
  29 import com.openpojo.validation.affirm.Affirm;
  30 import com.openpojo.validation.rule.Rule;
  31
  32 public class HasToStringRule implements Rule {
  33
  34     private final Matcher m;
  35
  36     public HasToStringRule() {
  37         m = anything();
  38     }
  39
  40     public HasToStringRule(Matcher m) {
  41         this.m = m;
  42     }
  43
  44     @Override
  45     public void evaluate(PojoClass pojoClass) {
  46         Class<?> clazz = pojoClass.getClazz();
  47         if (anyOf(m).matches(clazz)) {
  48             boolean hasToString = false;
  49             final String name = clazz.getSimpleName();
  50             final Method[] methods;
  51             if (clazz.getSuperclass().equals(Object.class)) {
  52                 methods = clazz.getDeclaredMethods();
  53             } else {
  54                 methods = clazz.getMethods();
  55             }
  56             for (Method method : methods) {
  57                 Parameter[] parameters = method.getParameters();
  58                 if ("toString".equals(method.getName()) && String.class.equals(method.getReturnType())
  59                         && parameters.length == 0) {
  60                     hasToString = true;
  61                     break;
  62                 }
  63             }
  64
  65             if (!hasToString) {
  66                 Affirm.fail(String.format("[%s] does not override toString", name));
  67             }
  68         }
  69     }
  70
  71 }