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
  26 import java.lang.reflect.Method;
  27 import java.lang.reflect.Parameter;
  28
  29 import org.hamcrest.Matcher;
  30
  31 import com.openpojo.reflection.PojoClass;
  32 import com.openpojo.validation.affirm.Affirm;
  33 import com.openpojo.validation.rule.Rule;
  34
  35 public class HasToStringRule implements Rule {
  36
  37         private final Matcher m;
  38         public HasToStringRule() {
  39                 m = anything();
  40         }
  41
  42         public HasToStringRule(Matcher m) {
  43                 this.m = m;
  44         }
  45         @Override
  46         public void evaluate(PojoClass pojoClass) {
  47                 Class<?> clazz = pojoClass.getClazz();
  48                 if (anyOf(m).matches(clazz)) {
  49                         boolean hasToString = false;
  50                         final String name = clazz.getSimpleName();
  51                         final Method[] methods;
  52                         if (clazz.getSuperclass().equals(Object.class)) {
  53                                 methods = clazz.getDeclaredMethods();
  54                         } else {
  55                                 methods = clazz.getMethods();
  56                         }
  57                         for (Method method : methods) {
  58                                 Parameter[] parameters = method.getParameters();
  59                                 if ("toString".equals(method.getName()) && String.class.equals(method.getReturnType()) && parameters.length == 0) {
  60                                         hasToString = true;
  61                                         break;
  62                                 }
  63                         }
  64
  65                         if (!hasToString) {
  66                                 Affirm.fail(String.format(
  67                                                 "[%s] does not override toString", name));
  68                         }
  69                 }
  70         }
  71
  72 }