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