org.springframework.core.type

Class StandardMethodMetadata

java.lang.Object

org.springframework.core.type.StandardMethodMetadata

All Implemented Interfaces:

AnnotatedTypeMetadata, MethodMetadata

public class StandardMethodMetadata
extends Object
implements MethodMetadata

MethodMetadata implementation that uses standard reflection to introspect a given Method.

Since:

3.0

Author:

Juergen Hoeller, Mark Pollack, Chris Beams, Phillip Webb

Constructor Summary

Constructors

Constructor and Description
StandardMethodMetadata(Method introspectedMethod) Create a new StandardMethodMetadata wrapper for the given Method.
StandardMethodMetadata(Method introspectedMethod, boolean nestedAnnotationsAsMap) Create a new StandardMethodMetadata wrapper for the given Method, providing the option to return any nested annotations or annotation arrays in the form of AnnotationAttributes instead of actual Annotation instances.

Method Summary

Modifier and Type	Method and Description
MultiValueMap<String,Object>	getAllAnnotationAttributes(String annotationName) Retrieve all attributes of all annotations of the given type, if any (i.e.
MultiValueMap<String,Object>	getAllAnnotationAttributes(String annotationName, boolean classValuesAsString) Retrieve all attributes of all annotations of the given type, if any (i.e.
Map<String,Object>	getAnnotationAttributes(String annotationName) Retrieve the attributes of the annotation of the given type, if any (i.e.
Map<String,Object>	getAnnotationAttributes(String annotationName, boolean classValuesAsString) Retrieve the attributes of the annotation of the given type, if any (i.e.
String	getDeclaringClassName() Return the fully-qualified name of the class that declares this method.
Method	getIntrospectedMethod() Return the underlying Method.
String	getMethodName() Return the name of the method.
String	getReturnTypeName() Return the fully-qualified name of this method's declared return type.
boolean	isAbstract() Return whether the underlying method is effectively abstract: i.e.
boolean	isAnnotated(String annotationName) Determine whether the underlying element has an annotation or meta-annotation of the given type defined.
boolean	isFinal() Return whether the underlying method is marked as 'final'.
boolean	isOverridable() Return whether the underlying method is overridable, i.e.
boolean	isStatic() Return whether the underlying method is declared as 'static'.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

StandardMethodMetadata

public StandardMethodMetadata(Method introspectedMethod)

Create a new StandardMethodMetadata wrapper for the given Method.

Parameters:

introspectedMethod - the Method to introspect

StandardMethodMetadata

public StandardMethodMetadata(Method introspectedMethod,
                              boolean nestedAnnotationsAsMap)

Create a new StandardMethodMetadata wrapper for the given Method, providing the option to return any nested annotations or annotation arrays in the form of AnnotationAttributes instead of actual Annotation instances.

Parameters:

introspectedMethod - the Method to introspect

nestedAnnotationsAsMap - return nested annotations and annotation arrays as AnnotationAttributes for compatibility with ASM-based AnnotationMetadata implementations

Since:

3.1.1

Method Detail

getIntrospectedMethod

public final Method getIntrospectedMethod()

Return the underlying Method.

getMethodName

public String getMethodName()

Description copied from interface: MethodMetadata

Return the name of the method.

Specified by:

getMethodName in interface MethodMetadata

getDeclaringClassName

public String getDeclaringClassName()

Description copied from interface: MethodMetadata

Return the fully-qualified name of the class that declares this method.

Specified by:

getDeclaringClassName in interface MethodMetadata

getReturnTypeName

public String getReturnTypeName()

Description copied from interface: MethodMetadata

Return the fully-qualified name of this method's declared return type.

Specified by:

getReturnTypeName in interface MethodMetadata

isAbstract

public boolean isAbstract()

Description copied from interface: MethodMetadata

Return whether the underlying method is effectively abstract: i.e. marked as abstract on a class or declared as a regular, non-default method in an interface.

Specified by:

isAbstract in interface MethodMetadata

isStatic

public boolean isStatic()

Description copied from interface: MethodMetadata

Return whether the underlying method is declared as 'static'.

Specified by:

isStatic in interface MethodMetadata

isFinal

public boolean isFinal()

Description copied from interface: MethodMetadata

Return whether the underlying method is marked as 'final'.

Specified by:

isFinal in interface MethodMetadata

isOverridable

public boolean isOverridable()

Description copied from interface: MethodMetadata

Return whether the underlying method is overridable, i.e. not marked as static, final or private.

Specified by:

isOverridable in interface MethodMetadata

isAnnotated

public boolean isAnnotated(String annotationName)

Description copied from interface: AnnotatedTypeMetadata

Determine whether the underlying element has an annotation or meta-annotation of the given type defined.

If this method returns true, then AnnotatedTypeMetadata.getAnnotationAttributes(java.lang.String) will return a non-null Map.

Specified by:

isAnnotated in interface AnnotatedTypeMetadata

Parameters:

annotationName - the fully qualified class name of the annotation type to look for

Returns:

whether a matching annotation is defined

getAnnotationAttributes

@Nullable
public Map<String,Object> getAnnotationAttributes(String annotationName)

Description copied from interface: AnnotatedTypeMetadata

Retrieve the attributes of the annotation of the given type, if any (i.e. if defined on the underlying element, as direct annotation or meta-annotation), also taking attribute overrides on composed annotations into account.

Specified by:

getAnnotationAttributes in interface AnnotatedTypeMetadata

Parameters:

annotationName - the fully qualified class name of the annotation type to look for

Returns:

a Map of attributes, with the attribute name as key (e.g. "value") and the defined attribute value as Map value. This return value will be null if no matching annotation is defined.

getAnnotationAttributes

@Nullable
public Map<String,Object> getAnnotationAttributes(String annotationName,
                                                            boolean classValuesAsString)

Description copied from interface: AnnotatedTypeMetadata

Retrieve the attributes of the annotation of the given type, if any (i.e. if defined on the underlying element, as direct annotation or meta-annotation), also taking attribute overrides on composed annotations into account.

Specified by:

getAnnotationAttributes in interface AnnotatedTypeMetadata

Parameters:

annotationName - the fully qualified class name of the annotation type to look for

classValuesAsString - whether to convert class references to String class names for exposure as values in the returned Map, instead of Class references which might potentially have to be loaded first

Returns:

a Map of attributes, with the attribute name as key (e.g. "value") and the defined attribute value as Map value. This return value will be null if no matching annotation is defined.

getAllAnnotationAttributes

@Nullable
public MultiValueMap<String,Object> getAllAnnotationAttributes(String annotationName)

Description copied from interface: AnnotatedTypeMetadata

Retrieve all attributes of all annotations of the given type, if any (i.e. if defined on the underlying element, as direct annotation or meta-annotation). Note that this variant does not take attribute overrides into account.

Specified by:

getAllAnnotationAttributes in interface AnnotatedTypeMetadata

Parameters:

annotationName - the fully qualified class name of the annotation type to look for

Returns:

a MultiMap of attributes, with the attribute name as key (e.g. "value") and a list of the defined attribute values as Map value. This return value will be null if no matching annotation is defined.

See Also:

AnnotatedTypeMetadata.getAllAnnotationAttributes(String, boolean)

getAllAnnotationAttributes

@Nullable
public MultiValueMap<String,Object> getAllAnnotationAttributes(String annotationName,
                                                                         boolean classValuesAsString)

Description copied from interface: AnnotatedTypeMetadata

Retrieve all attributes of all annotations of the given type, if any (i.e. if defined on the underlying element, as direct annotation or meta-annotation). Note that this variant does not take attribute overrides into account.

Specified by:

getAllAnnotationAttributes in interface AnnotatedTypeMetadata

Parameters:

annotationName - the fully qualified class name of the annotation type to look for

classValuesAsString - whether to convert class references to String

Returns:

a MultiMap of attributes, with the attribute name as key (e.g. "value") and a list of the defined attribute values as Map value. This return value will be null if no matching annotation is defined.

See Also:

AnnotatedTypeMetadata.getAllAnnotationAttributes(String)