common/src/main/java/org/onap/so/openpojo/rules/HasAnnotationMatcher.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.anything;
  24 import java.lang.annotation.Annotation;
  25 import org.hamcrest.Description;
  26 import org.hamcrest.Matcher;
  27 import org.hamcrest.TypeSafeDiagnosingMatcher;
  28 import com.openpojo.reflection.PojoField;
  29
  30 public class HasAnnotationMatcher<T extends PojoField> extends TypeSafeDiagnosingMatcher<T> {
  31     private final Class<? extends Annotation> annotationType;
  32     private final Matcher<? super T> annotationMatcher;
  33
  34     public HasAnnotationMatcher(final Class<? extends Annotation> annotationType,
  35             final Matcher<? super T> annotationMatcher) {
  36         this.annotationType = annotationType;
  37         this.annotationMatcher = annotationMatcher;
  38     }
  39
  40     @Override
  41     protected boolean matchesSafely(final PojoField item, final Description mismatchDescription) {
  42         final Annotation annotation = item.getAnnotation(this.annotationType);
  43         if (annotation == null) {
  44             mismatchDescription.appendText("does not have annotation ").appendText(this.annotationType.getName());
  45             return false;
  46         }
  47
  48         if (!this.annotationMatcher.matches(annotation)) {
  49             this.annotationMatcher.describeMismatch(annotation, mismatchDescription);
  50             return false;
  51         }
  52
  53         return true;
  54     }
  55
  56     @Override
  57     public void describeTo(final Description description) {
  58         // Intentionally left blank.
  59     }
  60
  61     public static <T extends PojoField> Matcher<T> hasAnnotation(final Class<? extends Annotation> annotationType) {
  62         return hasAnnotation(annotationType, anything(""));
  63     }
  64
  65     public static <T extends PojoField> Matcher<T> hasAnnotation(final Class<? extends Annotation> annotationType,
  66             final Matcher<? super T> annotationMatcher) {
  67         return new HasAnnotationMatcher<T>(annotationType, annotationMatcher);
  68     }
  69 }