Improve javadoc on reactive classes
Ensure type-level Javadoc in every class, comply with guidelines for 80 char on Javadoc, and minor polish.
This commit is contained in:
@@ -21,8 +21,8 @@ import java.util.Set;
|
||||
import org.springframework.http.MediaType;
|
||||
|
||||
/**
|
||||
* An extension of {@link RequestedContentTypeResolver} that maintains a mapping between
|
||||
* keys (e.g. file extension, query parameter) and media types.
|
||||
* An extension of {@link RequestedContentTypeResolver} that maintains a mapping
|
||||
* between keys (e.g. file extension, query parameter) and media types.
|
||||
*
|
||||
* @author Rossen Stoyanchev
|
||||
* @since 5.0
|
||||
|
||||
@@ -27,8 +27,8 @@ import org.springframework.web.server.NotAcceptableStatusException;
|
||||
import org.springframework.web.server.ServerWebExchange;
|
||||
|
||||
/**
|
||||
* A {@link RequestedContentTypeResolver} that extracts the media type lookup key from a
|
||||
* known query parameter named "format" by default.
|
||||
* A {@link RequestedContentTypeResolver} that extracts the media type lookup
|
||||
* key from a known query parameter named "format" by default.
|
||||
*
|
||||
* @author Rossen Stoyanchev
|
||||
* @since 5.0
|
||||
|
||||
@@ -31,8 +31,8 @@ import org.springframework.web.server.ServerWebExchange;
|
||||
import org.springframework.web.util.WebUtils;
|
||||
|
||||
/**
|
||||
* A {@link RequestedContentTypeResolver} that extracts the file extension from the
|
||||
* request path and uses that as the media type lookup key.
|
||||
* A {@link RequestedContentTypeResolver} that extracts the file extension from
|
||||
* the request path and uses that as the media type lookup key.
|
||||
*
|
||||
* <p>If the file extension is not found in the explicit registrations provided
|
||||
* to the constructor, the Java Activation Framework (JAF) is used as a fallback
|
||||
|
||||
@@ -22,7 +22,8 @@ import org.springframework.web.server.NotAcceptableStatusException;
|
||||
import org.springframework.web.server.ServerWebExchange;
|
||||
|
||||
/**
|
||||
* Strategy for resolving the requested media types for a {@code ServerWebExchange}.
|
||||
* Strategy for resolving the requested media types for a
|
||||
* {@code ServerWebExchange}.
|
||||
*
|
||||
* @author Rossen Stoyanchev
|
||||
* @since 5.0
|
||||
|
||||
@@ -28,9 +28,9 @@ import org.springframework.util.CollectionUtils;
|
||||
|
||||
/**
|
||||
* Factory to create a {@link CompositeContentTypeResolver} and configure it with
|
||||
* one or more {@link RequestedContentTypeResolver} instances with build style methods.
|
||||
* The following table shows methods, resulting strategy instances, and if in
|
||||
* use by default:
|
||||
* one or more {@link RequestedContentTypeResolver} instances with build style
|
||||
* methods. The following table shows methods, resulting strategy instances, and
|
||||
* if in use by default:
|
||||
*
|
||||
* <table>
|
||||
* <tr>
|
||||
@@ -65,9 +65,10 @@ import org.springframework.util.CollectionUtils;
|
||||
* </tr>
|
||||
* </table>
|
||||
*
|
||||
* <p>The order in which resolvers are configured is fixed. Config methods may only
|
||||
* turn individual resolvers on or off. If you need a custom order for any
|
||||
* reason simply instantiate {@code {@link CompositeContentTypeResolver}} directly.
|
||||
* <p>The order in which resolvers are configured is fixed. Config methods may
|
||||
* only turn individual resolvers on or off. If you need a custom order for any
|
||||
* reason simply instantiate {@code {@link CompositeContentTypeResolver}}
|
||||
* directly.
|
||||
*
|
||||
* <p>For the path extension and parameter resolvers you may explicitly add
|
||||
* {@link #mediaTypes(Map)}. This will be used to resolve path extensions or a
|
||||
|
||||
@@ -40,6 +40,9 @@ import org.springframework.web.server.ServerWebExchange;
|
||||
|
||||
|
||||
/**
|
||||
* Extension of HandlerMethod that can invoke the target method after resolving
|
||||
* its method arguments.
|
||||
*
|
||||
* @author Rossen Stoyanchev
|
||||
* @since 5.0
|
||||
*/
|
||||
|
||||
@@ -34,6 +34,7 @@ import org.springframework.web.reactive.HandlerResult;
|
||||
import org.springframework.web.server.ServerWebExchange;
|
||||
|
||||
/**
|
||||
* Base class for {@link View} implementations.
|
||||
*
|
||||
* @author Rossen Stoyanchev
|
||||
* @since 5.0
|
||||
|
||||
Reference in New Issue
Block a user