From b18919d111b3ae6f60df4a85fd668c6fe04fa677 Mon Sep 17 00:00:00 2001 From: Sebastien Deleuze Date: Wed, 25 Nov 2015 10:35:09 +0100 Subject: [PATCH] Improve Javadoc for HandlerAdapter and HandlerMapping --- .../org/springframework/web/reactive/HandlerAdapter.java | 2 +- .../org/springframework/web/reactive/HandlerMapping.java | 9 +++++++++ 2 files changed, 10 insertions(+), 1 deletion(-) diff --git a/spring-web-reactive/src/main/java/org/springframework/web/reactive/HandlerAdapter.java b/spring-web-reactive/src/main/java/org/springframework/web/reactive/HandlerAdapter.java index 605676a56b..da3284efee 100644 --- a/spring-web-reactive/src/main/java/org/springframework/web/reactive/HandlerAdapter.java +++ b/spring-web-reactive/src/main/java/org/springframework/web/reactive/HandlerAdapter.java @@ -52,7 +52,7 @@ public interface HandlerAdapter { * @param handler handler to use. This object must have previously been passed * to the {@code supports} method of this interface, which must have * returned {@code true}. - * @return An {@link HandlerResult} instance + * @return A {@link Publisher} object that produces a single {@link HandlerResult} element */ Publisher handle(ReactiveServerHttpRequest request, ReactiveServerHttpResponse response, Object handler); diff --git a/spring-web-reactive/src/main/java/org/springframework/web/reactive/HandlerMapping.java b/spring-web-reactive/src/main/java/org/springframework/web/reactive/HandlerMapping.java index 0fd4741666..5b60cc86da 100644 --- a/spring-web-reactive/src/main/java/org/springframework/web/reactive/HandlerMapping.java +++ b/spring-web-reactive/src/main/java/org/springframework/web/reactive/HandlerMapping.java @@ -21,10 +21,19 @@ import org.reactivestreams.Publisher; import org.springframework.http.server.ReactiveServerHttpRequest; /** + * Interface to be implemented by objects that define a mapping between + * requests and handler objects. + * * @author Rossen Stoyanchev + * @author Sebastien Deleuze */ public interface HandlerMapping { + /** + * Return a handler for this request. + * @param request current HTTP request + * @return A {@link Publisher} object that produces a single handler element + */ Publisher getHandler(ReactiveServerHttpRequest request); }