org.springframework.data.util.AnnotationDetectionMethodCallback Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of spring-data-commons Show documentation
There is a newer version: 3.4.0
/*
 * Copyright 2014-2024 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.data.util;

import java.lang.annotation.Annotation;
import java.lang.reflect.Method;

import org.springframework.core.annotation.AnnotatedElementUtils;
import org.springframework.lang.Nullable;
import org.springframework.util.Assert;
import org.springframework.util.ReflectionUtils;
import org.springframework.util.ReflectionUtils.MethodCallback;

/**
 * {@link MethodCallback} to find annotations of a given type.
 *
 * @author Oliver Gierke
 * @author Christoph Strobl
 * @author Mark Paluch
 * @author Johannes Englmeier
 */
public class AnnotationDetectionMethodCallback implements MethodCallback {

	private static final String MULTIPLE_FOUND = "Found annotation %s both on %s and %s; Make sure only one of them is annotated with it";

	private final boolean enforceUniqueness;
	private final Class annotationType;

	private @Nullable Method foundMethod;
	private @Nullable A annotation;

	/**
	 * Creates a new {@link AnnotationDetectionMethodCallback} for the given annotation type.
	 *
	 * @param annotationType must not be {@literal null}.
	 */
	public AnnotationDetectionMethodCallback(Class annotationType) {
		this(annotationType, false);
	}

	/**
	 * Creates a new {@link AnnotationDetectionMethodCallback} for the given annotation type.
	 *
	 * @param annotationType must not be {@literal null}.
	 * @param enforceUniqueness whether to fail if multiple methods with the annotation are found.
	 */
	public AnnotationDetectionMethodCallback(Class annotationType, boolean enforceUniqueness) {

		Assert.notNull(annotationType, "Annotation type must not be null");

		this.annotationType = annotationType;
		this.enforceUniqueness = enforceUniqueness;
	}

	/**
	 * @return the method
	 */
	@Nullable
	public Method getMethod() {
		return foundMethod;
	}

	/**
	 * Returns the method with the configured annotation.
	 *
	 * @return
	 * @throws IllegalStateException in case no method with the configured annotation was found.
	 */
	public Method getRequiredMethod() {

		Method method = this.foundMethod;

		if (method == null) {
			throw new IllegalStateException(String.format("No method with annotation %s found", annotationType));
		}

		return method;
	}

	/**
	 * @return the annotation
	 */
	@Nullable
	public A getAnnotation() {
		return annotation;
	}

	/**
	 * Returns whether an annotation was found.
	 *
	 * @return
	 */
	public boolean hasFoundAnnotation() {
		return annotation != null;
	}

	@Override
	public void doWith(Method method) throws IllegalArgumentException, IllegalAccessException {

		if (foundMethod != null && !enforceUniqueness) {
			return;
		}

		A foundAnnotation = AnnotatedElementUtils.findMergedAnnotation(method, annotationType);

		if (foundAnnotation != null) {

			if (foundMethod != null && enforceUniqueness) {
				throw new IllegalStateException(
						String.format(MULTIPLE_FOUND, foundAnnotation.getClass().getName(), foundMethod, method));
			}

			this.annotation = foundAnnotation;
			this.foundMethod = method;
		}
	}

	/**
	 * Invokes the method using reflection.
	 *
	 * @param target can be {@literal null} for static method invocations.
	 * @param args method arguments.
	 * @return
	 * @since 2.7
	 */
	@Nullable
	@SuppressWarnings("unchecked")
	public  T invoke(@Nullable Object target, Object... args) {

		Method method = this.foundMethod;

		if (method == null) {
			return null;
		}

		ReflectionUtils.makeAccessible(method);
		return (T) ReflectionUtils.invokeMethod(method, target, args);
	}
}