common/src/main/java/org/openecomp/mso/openpojo/rules/HasAnnotationMatcher.java

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