/*
* Copyright 2012-2019 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.boot.test.autoconfigure.filter;
import java.lang.annotation.Annotation;
import java.util.Collections;
import java.util.Set;
import org.springframework.context.annotation.ComponentScan.Filter;
import org.springframework.core.ResolvableType;
import org.springframework.core.annotation.MergedAnnotation;
import org.springframework.core.annotation.MergedAnnotations;
import org.springframework.core.annotation.MergedAnnotations.SearchStrategy;
AnnotationCustomizableTypeExcludeFilter
that can be used to any test annotation that uses the standard includeFilters
, excludeFilters
and useDefaultFilters
attributes. Author: Phillip Webb Type parameters: - <A> – the annotation type
Since: 2.2.0
/**
* {@link AnnotationCustomizableTypeExcludeFilter} that can be used to any test annotation
* that uses the standard {@code includeFilters}, {@code excludeFilters} and
* {@code useDefaultFilters} attributes.
*
* @param <A> the annotation type
* @author Phillip Webb
* @since 2.2.0
*/
public abstract class StandardAnnotationCustomizableTypeExcludeFilter<A extends Annotation>
extends AnnotationCustomizableTypeExcludeFilter {
private static final Filter[] NO_FILTERS = {};
private static final String[] FILTER_TYPE_ATTRIBUTES;
static {
FilterType[] filterValues = FilterType.values();
FILTER_TYPE_ATTRIBUTES = new String[filterValues.length];
for (int i = 0; i < filterValues.length; i++) {
FILTER_TYPE_ATTRIBUTES[i] = filterValues[i].name().toLowerCase() + "Filters";
}
}
private MergedAnnotation<A> annotation;
protected StandardAnnotationCustomizableTypeExcludeFilter(Class<?> testClass) {
this.annotation = MergedAnnotations.from(testClass, SearchStrategy.INHERITED_ANNOTATIONS)
.get(getAnnotationType());
}
protected final MergedAnnotation<A> getAnnotation() {
return this.annotation;
}
@Override
protected boolean hasAnnotation() {
return this.annotation.isPresent();
}
@Override
protected Filter[] getFilters(FilterType type) {
return this.annotation.getValue(FILTER_TYPE_ATTRIBUTES[type.ordinal()], Filter[].class).orElse(NO_FILTERS);
}
@Override
protected boolean isUseDefaultFilters() {
return this.annotation.getValue("useDefaultFilters", Boolean.class).orElse(false);
}
@Override
protected Set<Class<?>> getDefaultIncludes() {
return Collections.emptySet();
}
@Override
protected Set<Class<?>> getComponentIncludes() {
return Collections.emptySet();
}
@SuppressWarnings("unchecked")
protected Class<A> getAnnotationType() {
ResolvableType type = ResolvableType.forClass(StandardAnnotationCustomizableTypeExcludeFilter.class,
getClass());
return (Class<A>) type.resolveGeneric();
}
}