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

Consistent table declarations (including fix for disarranged FTL macros) 

Issue: SPR-16612
This commit is contained in:
Juergen Hoeller 2018-03-19 12:41:22 +01:00
parent 702b27e1e4
commit 578c04ea17
4 changed files with 350 additions and 359 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
src/docs/asciidoc/web/webflux.adoc
View File

@ -427,22 +427,18 @@ The table below lists the components that `WebHttpHandlerBuilder` detects:
| `WebSessionManager`
| 0..1
| The manager for ``WebSession``'s exposed through a method on `ServerWebExchange`.
`DefaultWebSessionManager` by default.
| "serverCodecConfigurer"
| `ServerCodecConfigurer`
| 0..1
|For access to ``HttpMessageReader``'s for parsing form data and multipart data that's
then exposed through methods on `ServerWebExchange`.
`ServerCodecConfigurer.create()` by default.
| For access to ``HttpMessageReader``'s for parsing form data and multipart data that's then
exposed through methods on `ServerWebExchange`. `ServerCodecConfigurer.create()` by default.
| "localeContextResolver"
| `LocaleContextResolver`
| 0..1
| The resolver for `LocaleContext` exposed through a method on `ServerWebExchange`.
`AcceptHeaderLocaleContextResolver` by default.
|===
@ -1163,13 +1159,11 @@ Supports reactive types.
| The current request locale, determined by the most specific `LocaleResolver` available, in
effect, the configured `LocaleResolver`/`LocaleContextResolver`.
|Java 6+: `java.util.TimeZone` +
Java 8+: `java.time.ZoneId`
| `java.util.TimeZone` + `java.time.ZoneId`
| The time zone associated with the current request, as determined by a `LocaleContextResolver`.
| `@PathVariable`
|For access to URI template variables.
See <<webflux-ann-requestmapping-uri-templates>>.
| For access to URI template variables. See <<webflux-ann-requestmapping-uri-templates>>.
| `@MatrixVariable`
| For access to name-value pairs in URI path segments. See <<webflux-ann-matrix-variables>>.
@ -1186,13 +1180,13 @@ See "Any other argument" further below in this table.
type. See <<webflux-ann-requestheader>>.
| `@CookieValue`
|For access to cookies. Cookies values are converted to the declared method argument
type. See <<webflux-ann-cookievalue>>.
| For access to cookies. Cookies values are converted to the declared method argument type.
See <<webflux-ann-cookievalue>>.
| `@RequestBody`
| For access to the HTTP request body. Body content is converted to the declared method
argument type using ``HttpMessageReader``'s. Supports reactive types.
<<webflux-ann-requestbody>>.
See <<webflux-ann-requestbody>>.
| `HttpEntity<B>`
| For access to request headers and body. The body is converted with ``HttpMessageReader``'s.
@ -1222,14 +1216,14 @@ immediately after the validated method argument.
| `SessionStatus` + class-level `@SessionAttributes`
| For marking form processing complete which triggers cleanup of session attributes
declared through a class-level `@SessionAttributes` annotation. See
<<webflux-ann-sessionattributes>> for more details.
declared through a class-level `@SessionAttributes` annotation.
See <<webflux-ann-sessionattributes>> for more details.
| `UriComponentsBuilder`
| For preparing a URL relative to the current request's host, port, scheme, context path, and
the literal part of the servlet mapping also taking into account `Forwarded` and
`X-Forwarded-*` headers.
// See <<webflux-uri-building>>.
// TODO: See <<webflux-uri-building>>.
| `@SessionAttribute`
| For access to any session attribute; in contrast to model attributes stored in the session
@ -1274,8 +1268,8 @@ See <<webflux-ann-responseentity>>.
| `String`
| A view name to be resolved with ``ViewResolver``'s and used together with the implicit
model -- determined through command objects and `@ModelAttribute` methods. The handler
method may also programmatically enrich the model by declaring a `Model` argument (see
above).
method may also programmatically enrich the model by declaring a `Model` argument
(see above).
| `View`
| A `View` instance to use for rendering together with the implicit model -- determined
@ -1301,7 +1295,7 @@ this table.
value) is considered to have fully handled the response if it also has a `ServerHttpResponse`,
or a `ServerWebExchange` argument, or an `@ResponseStatus` annotation. The same is true also
if the controller has made a positive ETag or lastModified timestamp check.
// TODO (see <<webflux-caching-etag-lastmodified>> for details)
// TODO: See <<webflux-caching-etag-lastmodified>> for details.
If none of the above is true, a `void` return type may also indicate "no response body" for
REST controllers, or default view name selection for HTML controllers.
@ -2590,8 +2584,7 @@ evaluated and if present a `304` status code is returned.
}
----
// TODO:
// See also <<webflux-caching-static-resources, HTTP caching support for static resources>>.
// TODO: See also <<webflux-caching-static-resources, HTTP caching support for static resources>>.
The resource handler also supports a chain of
{api-spring-framework}/web/reactive/resource/ResourceResolver.html[ResourceResolver]'s and

2
src/docs/asciidoc/web/webmvc-view.adoc
View File

@ -214,7 +214,7 @@ parameter list that each takes.
[[views-macros-defs-tbl]]
.Table of macro definitions
[cols="3,1,1"]
[cols="3,1"]
|===
| macro | FTL definition

20
src/docs/asciidoc/web/webmvc.adoc
View File

@ -528,7 +528,6 @@ error pages in a browser application.
| {api-spring-framework}/web/servlet/mvc/support/DefaultHandlerExceptionResolver.html[DefaultHandlerExceptionResolver]
| Resolves exceptions raised by Spring MVC and maps them to HTTP status codes.
Also see alternative `ResponseEntityExceptionHandler` and <<mvc-ann-rest-exceptions>>.
| `ResponseStatusExceptionResolver`
@ -1581,8 +1580,7 @@ requests are allowed to access a session concurrently.
| The current request locale, determined by the most specific `LocaleResolver` available, in
effect, the configured `LocaleResolver`/`LocaleContextResolver`.
|Java 6+: `java.util.TimeZone` +
Java 8+: `java.time.ZoneId`
| `java.util.TimeZone` + `java.time.ZoneId`
| The time zone associated with the current request, as determined by a `LocaleContextResolver`.
| `java.io.InputStream`, `java.io.Reader`
@ -1699,8 +1697,8 @@ See <<mvc-ann-responseentity>>.
| `String`
| A view name to be resolved with ``ViewResolver``'s and used together with the implicit
model -- determined through command objects and `@ModelAttribute` methods. The handler
method may also programmatically enrich the model by declaring a `Model` argument (see
above).
method may also programmatically enrich the model by declaring a `Model` argument
(see above).
| `View`
| A `View` instance to use for rendering together with the implicit model -- determined
@ -1723,8 +1721,8 @@ this table.
| `void`
| A method with a `void` return type (or `null` return value) is considered to have fully
handled the response if it also has a `ServletResponse`, or an `OutputStream` argument, or an
`@ResponseStatus` annotation. The same is true also if the controller has made a positive
handled the response if it also has a `ServletResponse`, or an `OutputStream` argument, or
an `@ResponseStatus` annotation. The same is true also if the controller has made a positive
ETag or lastModified timestamp check (see <<mvc-caching-etag-lastmodified>> for details).
If none of the above is true, a `void` return type may also indicate "no response body" for
@ -1758,10 +1756,10 @@ See <<mvc-ann-async>> and <<mvc-ann-async-http-streaming>>.
| Alternative to ``DeferredResult` with multi-value streams (e.g. `Flux`, `Observable`)
collected to a `List`.
For streaming scenarios -- .e.g. `text/event-stream`, `application/json+stream`,
`SseEmitter` and `ResponseBodyEmitter` are used instead, where `ServletOutputStream` blocking
I/O is performed on a Spring MVC managed thread and back pressure applied against the
completion of each write.
For streaming scenarios -- e.g. `text/event-stream`, `application/json+stream` --
`SseEmitter` and `ResponseBodyEmitter` are used instead, where `ServletOutputStream`
blocking I/O is performed on a Spring MVC managed thread and back pressure applied
against the completion of each write.
See <<mvc-ann-async>> and <<mvc-ann-async-reactive-types>>.