org.springframework.web.method.annotation

Class ExceptionHandlerMethodResolver

java.lang.Object

org.springframework.web.method.annotation.ExceptionHandlerMethodResolver

public class ExceptionHandlerMethodResolver
extends java.lang.Object

Discovers @ExceptionHandler methods in a given class, including all of its superclasses, and helps to resolve a given Exception to the exception types supported by a given Method.

Since:

3.1

Author:

Rossen Stoyanchev

Field Summary

Fields

Modifier and Type	Field and Description
static ReflectionUtils.MethodFilter	EXCEPTION_HANDLER_METHODS A filter for selecting @ExceptionHandler methods.
private java.util.Map<java.lang.Class<? extends java.lang.Throwable>,java.lang.reflect.Method>	exceptionLookupCache
private java.util.Map<java.lang.Class<? extends java.lang.Throwable>,java.lang.reflect.Method>	mappedMethods
private static java.lang.reflect.Method	NO_METHOD_FOUND Arbitrary Method reference, indicating no method found in the cache.

Constructor Summary

Constructors

Constructor and Description
ExceptionHandlerMethodResolver(java.lang.Class<?> handlerType) A constructor that finds ExceptionHandler methods in the given type.

Method Summary

Modifier and Type	Method and Description
private void	addExceptionMapping(java.lang.Class<? extends java.lang.Throwable> exceptionType, java.lang.reflect.Method method)
protected void	detectAnnotationExceptionMappings(java.lang.reflect.Method method, java.util.List<java.lang.Class<? extends java.lang.Throwable>> result)
private java.util.List<java.lang.Class<? extends java.lang.Throwable>>	detectExceptionMappings(java.lang.reflect.Method method) Extract exception mappings from the @ExceptionHandler annotation first, and then as a fallback from the method signature itself.
private java.lang.reflect.Method	getMappedMethod(java.lang.Class<? extends java.lang.Exception> exceptionType) Return the Method mapped to the given exception type, or null if none.
boolean	hasExceptionMappings() Whether the contained type has any exception mappings.
java.lang.reflect.Method	resolveMethod(java.lang.Exception exception) Find a Method to handle the given exception.
java.lang.reflect.Method	resolveMethodByExceptionType(java.lang.Class<? extends java.lang.Exception> exceptionType) Find a Method to handle the given exception type.

Methods inherited from class java.lang.Object

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

Field Detail

EXCEPTION_HANDLER_METHODS

public static final ReflectionUtils.MethodFilter EXCEPTION_HANDLER_METHODS

A filter for selecting @ExceptionHandler methods.

NO_METHOD_FOUND

private static final java.lang.reflect.Method NO_METHOD_FOUND

Arbitrary Method reference, indicating no method found in the cache.

mappedMethods

private final java.util.Map<java.lang.Class<? extends java.lang.Throwable>,java.lang.reflect.Method> mappedMethods

exceptionLookupCache

private final java.util.Map<java.lang.Class<? extends java.lang.Throwable>,java.lang.reflect.Method> exceptionLookupCache

Constructor Detail

ExceptionHandlerMethodResolver

public ExceptionHandlerMethodResolver(java.lang.Class<?> handlerType)

A constructor that finds ExceptionHandler methods in the given type.

Parameters:

handlerType - the type to introspect

Method Detail

detectExceptionMappings

private java.util.List<java.lang.Class<? extends java.lang.Throwable>> detectExceptionMappings(java.lang.reflect.Method method)

Extract exception mappings from the @ExceptionHandler annotation first, and then as a fallback from the method signature itself.

detectAnnotationExceptionMappings

protected void detectAnnotationExceptionMappings(java.lang.reflect.Method method,
                                                 java.util.List<java.lang.Class<? extends java.lang.Throwable>> result)

addExceptionMapping

private void addExceptionMapping(java.lang.Class<? extends java.lang.Throwable> exceptionType,
                                 java.lang.reflect.Method method)

hasExceptionMappings

public boolean hasExceptionMappings()

Whether the contained type has any exception mappings.

resolveMethod

public java.lang.reflect.Method resolveMethod(java.lang.Exception exception)

Find a Method to handle the given exception. Use ExceptionDepthComparator if more than one match is found.

Parameters:

exception - the exception

Returns:

a Method to handle the exception, or null if none found

resolveMethodByExceptionType

public java.lang.reflect.Method resolveMethodByExceptionType(java.lang.Class<? extends java.lang.Exception> exceptionType)

Find a Method to handle the given exception type. This can be useful if an Exception instance is not available (e.g. for tools).

Parameters:

exceptionType - the exception type

Returns:

a Method to handle the exception, or null if none found

getMappedMethod

private java.lang.reflect.Method getMappedMethod(java.lang.Class<? extends java.lang.Exception> exceptionType)

Return the Method mapped to the given exception type, or null if none.