root
/
spring-framework
mirror of https://github.com/spring-projects/spring-framework.git
1
0
Fork 0
Code Issues Actions Packages Projects Releases Wiki Activity

Polish Javadoc for base ExceptionHandlerMethodResolvers

This commit is contained in:
Sam Brannen 2021-01-11 12:40:50 +01:00
parent 570bdbd253
commit 2fd6e6e87c
2 changed files with 15 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
spring-messaging/src/main/java/org/springframework/messaging/handler/invocation/AbstractExceptionHandlerMethodResolver.java
View File

@ -66,9 +66,9 @@ public abstract class AbstractExceptionHandlerMethodResolver {
} }
/** /**
* Extract the exceptions this method handles.This implementation looks for * Extract the exceptions this method handles. This implementation looks for
* sub-classes of Throwable in the method signature. * sub-classes of Throwable in the method signature.
* The method is static to ensure safe use from sub-class constructors. * <p>The method is static to ensure safe use from sub-class constructors.
*/ */
@SuppressWarnings("unchecked") @SuppressWarnings("unchecked")
protected static List<Class<? extends Throwable>> getExceptionsFromMethodSignature(Method method) { protected static List<Class<? extends Throwable>> getExceptionsFromMethodSignature(Method method) {
@ -94,7 +94,7 @@ public abstract class AbstractExceptionHandlerMethodResolver {
/** /**
* Find a {@link Method} to handle the given exception. * Find a {@link Method} to handle the given exception.
* Use {@link ExceptionDepthComparator} if more than one match is found. * <p>Uses {@link ExceptionDepthComparator} if more than one match is found.
* @param exception the exception * @param exception the exception
* @return a Method to handle the exception, or {@code null} if none found * @return a Method to handle the exception, or {@code null} if none found
*/ */
@ -113,6 +113,7 @@ public abstract class AbstractExceptionHandlerMethodResolver {
/** /**
* Find a {@link Method} to handle the given exception type. This can be * Find a {@link Method} to handle the given exception type. This can be
* useful if an {@link Exception} instance is not available (e.g. for tools). * useful if an {@link Exception} instance is not available (e.g. for tools).
* <p>Uses {@link ExceptionDepthComparator} if more than one match is found.
* @param exceptionType the exception type * @param exceptionType the exception type
* @return a Method to handle the exception, or {@code null} if none found * @return a Method to handle the exception, or {@code null} if none found
* @since 4.3.1 * @since 4.3.1
@ -128,7 +129,8 @@ public abstract class AbstractExceptionHandlerMethodResolver {
} }
/** /**
* Return the {@link Method} mapped to the given exception type, or {@code null} if none. * Return the {@link Method} mapped to the given exception type, or
* {@link #NO_MATCHING_EXCEPTION_HANDLER_METHOD} if none.
*/ */
@Nullable @Nullable
private Method getMappedMethod(Class<? extends Throwable> exceptionType) { private Method getMappedMethod(Class<? extends Throwable> exceptionType) {
@ -150,8 +152,9 @@ public abstract class AbstractExceptionHandlerMethodResolver {
} }
/** /**
* For the NO_MATCHING_EXCEPTION_HANDLER_METHOD constant. * For the {@link #NO_MATCHING_EXCEPTION_HANDLER_METHOD} constant.
*/ */
@SuppressWarnings("unused")
private void noMatchingExceptionHandler() { private void noMatchingExceptionHandler() {
} }

11
spring-web/src/main/java/org/springframework/web/method/annotation/ExceptionHandlerMethodResolver.java
View File

@ -125,7 +125,7 @@ public class ExceptionHandlerMethodResolver {
/** /**
* Find a {@link Method} to handle the given exception. * Find a {@link Method} to handle the given exception.
* Use {@link ExceptionDepthComparator} if more than one match is found. * <p>Uses {@link ExceptionDepthComparator} if more than one match is found.
* @param exception the exception * @param exception the exception
* @return a Method to handle the exception, or {@code null} if none found * @return a Method to handle the exception, or {@code null} if none found
*/ */
@ -136,7 +136,7 @@ public class ExceptionHandlerMethodResolver {
/** /**
* Find a {@link Method} to handle the given Throwable. * Find a {@link Method} to handle the given Throwable.
* Use {@link ExceptionDepthComparator} if more than one match is found. * <p>Uses {@link ExceptionDepthComparator} if more than one match is found.
* @param exception the exception * @param exception the exception
* @return a Method to handle the exception, or {@code null} if none found * @return a Method to handle the exception, or {@code null} if none found
* @since 5.0 * @since 5.0
@ -156,6 +156,7 @@ public class ExceptionHandlerMethodResolver {
/** /**
* Find a {@link Method} to handle the given exception type. This can be * Find a {@link Method} to handle the given exception type. This can be
* useful if an {@link Exception} instance is not available (e.g. for tools). * useful if an {@link Exception} instance is not available (e.g. for tools).
* <p>Uses {@link ExceptionDepthComparator} if more than one match is found.
* @param exceptionType the exception type * @param exceptionType the exception type
* @return a Method to handle the exception, or {@code null} if none found * @return a Method to handle the exception, or {@code null} if none found
*/ */
@ -170,7 +171,8 @@ public class ExceptionHandlerMethodResolver {
} }
/** /**
* Return the {@link Method} mapped to the given exception type, or {@code null} if none. * Return the {@link Method} mapped to the given exception type, or
* {@link #NO_MATCHING_EXCEPTION_HANDLER_METHOD} if none.
*/ */
private Method getMappedMethod(Class<? extends Throwable> exceptionType) { private Method getMappedMethod(Class<? extends Throwable> exceptionType) {
List<Class<? extends Throwable>> matches = new ArrayList<>(); List<Class<? extends Throwable>> matches = new ArrayList<>();
@ -191,8 +193,9 @@ public class ExceptionHandlerMethodResolver {
} }
/** /**
* For the NO_MATCHING_EXCEPTION_HANDLER_METHOD constant. * For the {@link #NO_MATCHING_EXCEPTION_HANDLER_METHOD} constant.
*/ */
@SuppressWarnings("unused")
private void noMatchingExceptionHandler() { private void noMatchingExceptionHandler() {
} }