org.springframework.core.annotation.SynthesizingMethodParameter Maven / Gradle / Ivy
/*
* Copyright 2002-2016 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
*
* http://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;
import java.lang.reflect.Constructor;
import java.lang.reflect.Executable;
import java.lang.reflect.Method;
import java.lang.reflect.Parameter;
import org.springframework.core.MethodParameter;
/**
* A {@link MethodParameter} variant which synthesizes annotations that
* declare attribute aliases via {@link AliasFor @AliasFor}.
*
* @author Juergen Hoeller
* @author Sam Brannen
* @since 4.2
* @see AnnotationUtils#synthesizeAnnotation
* @see AnnotationUtils#synthesizeAnnotationArray
*/
public class SynthesizingMethodParameter extends MethodParameter {
/**
* Create a new {@code SynthesizingMethodParameter} for the given method,
* with nesting level 1.
* @param method the Method to specify a parameter for
* @param parameterIndex the index of the parameter: -1 for the method
* return type; 0 for the first method parameter; 1 for the second method
* parameter, etc.
*/
public SynthesizingMethodParameter(Method method, int parameterIndex) {
super(method, parameterIndex);
}
/**
* Create a new {@code SynthesizingMethodParameter} for the given method.
* @param method the Method to specify a parameter for
* @param parameterIndex the index of the parameter: -1 for the method
* return type; 0 for the first method parameter; 1 for the second method
* parameter, etc.
* @param nestingLevel the nesting level of the target type
* (typically 1; e.g. in case of a List of Lists, 1 would indicate the
* nested List, whereas 2 would indicate the element of the nested List)
*/
public SynthesizingMethodParameter(Method method, int parameterIndex, int nestingLevel) {
super(method, parameterIndex, nestingLevel);
}
/**
* Create a new {@code SynthesizingMethodParameter} for the given constructor,
* with nesting level 1.
* @param constructor the Constructor to specify a parameter for
* @param parameterIndex the index of the parameter
*/
public SynthesizingMethodParameter(Constructor constructor, int parameterIndex) {
super(constructor, parameterIndex);
}
/**
* Create a new {@code SynthesizingMethodParameter} for the given constructor.
* @param constructor the Constructor to specify a parameter for
* @param parameterIndex the index of the parameter
* @param nestingLevel the nesting level of the target type
* (typically 1; e.g. in case of a List of Lists, 1 would indicate the
* nested List, whereas 2 would indicate the element of the nested List)
*/
public SynthesizingMethodParameter(Constructor constructor, int parameterIndex, int nestingLevel) {
super(constructor, parameterIndex, nestingLevel);
}
/**
* Copy constructor, resulting in an independent {@code SynthesizingMethodParameter}
* based on the same metadata and cache state that the original object was in.
* @param original the original SynthesizingMethodParameter object to copy from
*/
protected SynthesizingMethodParameter(SynthesizingMethodParameter original) {
super(original);
}
@Override
protected A adaptAnnotation(A annotation) {
return AnnotationUtils.synthesizeAnnotation(annotation, getAnnotatedElement());
}
@Override
protected Annotation[] adaptAnnotationArray(Annotation[] annotations) {
return AnnotationUtils.synthesizeAnnotationArray(annotations, getAnnotatedElement());
}
@Override
public SynthesizingMethodParameter clone() {
return new SynthesizingMethodParameter(this);
}
/**
* Create a new SynthesizingMethodParameter for the given method or constructor.
* This is a convenience factory method for scenarios where a
* Method or Constructor reference is treated in a generic fashion.
* @param executable the Method or Constructor to specify a parameter for
* @param parameterIndex the index of the parameter
* @return the corresponding SynthesizingMethodParameter instance
* @since 5.0
*/
public static SynthesizingMethodParameter forExecutable(Executable executable, int parameterIndex) {
if (executable instanceof Method) {
return new SynthesizingMethodParameter((Method) executable, parameterIndex);
}
else if (executable instanceof Constructor) {
return new SynthesizingMethodParameter((Constructor) executable, parameterIndex);
}
else {
throw new IllegalArgumentException("Not a Method/Constructor: " + executable);
}
}
/**
* Create a new SynthesizingMethodParameter for the given parameter descriptor.
*
This is a convenience factory method for scenarios where a
* Java 8 {@link Parameter} descriptor is already available.
* @param parameter the parameter descriptor
* @return the corresponding SynthesizingMethodParameter instance
* @since 5.0
*/
public static SynthesizingMethodParameter forParameter(Parameter parameter) {
return forExecutable(parameter.getDeclaringExecutable(), findParameterIndex(parameter));
}
}