org.springframework.core.annotation.MergedAnnotationSelector Maven / Gradle / Ivy
/*
* Copyright 2002-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.core.annotation;
import java.lang.annotation.Annotation;
/**
* Strategy interface used to select between two {@link MergedAnnotation}
* instances.
*
* @author Phillip Webb
* @since 5.2
* @param the annotation type
* @see MergedAnnotationSelectors
*/
@FunctionalInterface
public interface MergedAnnotationSelector {
/**
* Determine if the existing annotation is known to be the best
* candidate and any subsequent selections may be skipped.
* @param annotation the annotation to check
* @return {@code true} if the annotation is known to be the best candidate
*/
default boolean isBestCandidate(MergedAnnotation annotation) {
return false;
}
/**
* Select the annotation that should be used.
* @param existing an existing annotation returned from an earlier result
* @param candidate a candidate annotation that may be better suited
* @return the most appropriate annotation from the {@code existing} or
* {@code candidate}
*/
MergedAnnotation select(MergedAnnotation existing, MergedAnnotation candidate);
}