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

ClientWebRequestBuilders documentation fix 

Issue: SPR-14561
This commit is contained in:
Juergen Hoeller 2016-08-08 13:20:27 +02:00
parent 5531e80724
commit aeec1245eb
2 changed files with 11 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
spring-web/src/main/java/org/springframework/web/client/reactive/ClientWebRequestBuilders.java
View File

@ -16,7 +16,6 @@
package org.springframework.web.client.reactive; package org.springframework.web.client.reactive;
import org.springframework.http.HttpMethod; import org.springframework.http.HttpMethod;
/** /**
@ -30,8 +29,7 @@ public abstract class ClientWebRequestBuilders {
/** /**
* Create a {@link DefaultClientWebRequestBuilder} for a GET request. * Create a {@link DefaultClientWebRequestBuilder} for a GET request.
* * @param urlTemplate a URL template; the resulting URL will be encoded
* @param urlTemplate a URL template; the resulting URL will be encoded
* @param urlVariables zero or more URL variables * @param urlVariables zero or more URL variables
*/ */
public static DefaultClientWebRequestBuilder get(String urlTemplate, Object... urlVariables) { public static DefaultClientWebRequestBuilder get(String urlTemplate, Object... urlVariables) {
@ -40,8 +38,7 @@ public abstract class ClientWebRequestBuilders {
/** /**
* Create a {@link DefaultClientWebRequestBuilder} for a POST request. * Create a {@link DefaultClientWebRequestBuilder} for a POST request.
* * @param urlTemplate a URL template; the resulting URL will be encoded
* @param urlTemplate a URL template; the resulting URL will be encoded
* @param urlVariables zero or more URL variables * @param urlVariables zero or more URL variables
*/ */
public static DefaultClientWebRequestBuilder post(String urlTemplate, Object... urlVariables) { public static DefaultClientWebRequestBuilder post(String urlTemplate, Object... urlVariables) {
@ -50,8 +47,7 @@ public abstract class ClientWebRequestBuilders {
/** /**
* Create a {@link DefaultClientWebRequestBuilder} for a PUT request. * Create a {@link DefaultClientWebRequestBuilder} for a PUT request.
* * @param urlTemplate a URL template; the resulting URL will be encoded
* @param urlTemplate a URL template; the resulting URL will be encoded
* @param urlVariables zero or more URL variables * @param urlVariables zero or more URL variables
*/ */
public static DefaultClientWebRequestBuilder put(String urlTemplate, Object... urlVariables) { public static DefaultClientWebRequestBuilder put(String urlTemplate, Object... urlVariables) {
@ -60,8 +56,7 @@ public abstract class ClientWebRequestBuilders {
/** /**
* Create a {@link DefaultClientWebRequestBuilder} for a PATCH request. * Create a {@link DefaultClientWebRequestBuilder} for a PATCH request.
* * @param urlTemplate a URL template; the resulting URL will be encoded
* @param urlTemplate a URL template; the resulting URL will be encoded
* @param urlVariables zero or more URL variables * @param urlVariables zero or more URL variables
*/ */
public static DefaultClientWebRequestBuilder patch(String urlTemplate, Object... urlVariables) { public static DefaultClientWebRequestBuilder patch(String urlTemplate, Object... urlVariables) {
@ -70,8 +65,7 @@ public abstract class ClientWebRequestBuilders {
/** /**
* Create a {@link DefaultClientWebRequestBuilder} for a DELETE request. * Create a {@link DefaultClientWebRequestBuilder} for a DELETE request.
* * @param urlTemplate a URL template; the resulting URL will be encoded
* @param urlTemplate a URL template; the resulting URL will be encoded
* @param urlVariables zero or more URL variables * @param urlVariables zero or more URL variables
*/ */
public static DefaultClientWebRequestBuilder delete(String urlTemplate, Object... urlVariables) { public static DefaultClientWebRequestBuilder delete(String urlTemplate, Object... urlVariables) {
@ -80,8 +74,7 @@ public abstract class ClientWebRequestBuilders {
/** /**
* Create a {@link DefaultClientWebRequestBuilder} for an OPTIONS request. * Create a {@link DefaultClientWebRequestBuilder} for an OPTIONS request.
* * @param urlTemplate a URL template; the resulting URL will be encoded
* @param urlTemplate a URL template; the resulting URL will be encoded
* @param urlVariables zero or more URL variables * @param urlVariables zero or more URL variables
*/ */
public static DefaultClientWebRequestBuilder options(String urlTemplate, Object... urlVariables) { public static DefaultClientWebRequestBuilder options(String urlTemplate, Object... urlVariables) {
@ -90,8 +83,7 @@ public abstract class ClientWebRequestBuilders {
/** /**
* Create a {@link DefaultClientWebRequestBuilder} for a HEAD request. * Create a {@link DefaultClientWebRequestBuilder} for a HEAD request.
* * @param urlTemplate a URL template; the resulting URL will be encoded
* @param urlTemplate a URL template; the resulting URL will be encoded
* @param urlVariables zero or more URL variables * @param urlVariables zero or more URL variables
*/ */
public static DefaultClientWebRequestBuilder head(String urlTemplate, Object... urlVariables) { public static DefaultClientWebRequestBuilder head(String urlTemplate, Object... urlVariables) {
@ -100,13 +92,12 @@ public abstract class ClientWebRequestBuilders {
/** /**
* Create a {@link DefaultClientWebRequestBuilder} for a request with the given HTTP method. * Create a {@link DefaultClientWebRequestBuilder} for a request with the given HTTP method.
* * @param httpMethod the HTTP method
* @param httpMethod the HTTP method * @param urlTemplate a URL template; the resulting URL will be encoded
* @param urlTemplate a URL template; the resulting URL will be encoded
* @param urlVariables zero or more URL variables * @param urlVariables zero or more URL variables
*/ */
public static DefaultClientWebRequestBuilder request(HttpMethod httpMethod, String urlTemplate, Object... urlVariables) { public static DefaultClientWebRequestBuilder request(HttpMethod httpMethod, String urlTemplate, Object... urlVariables) {
return new DefaultClientWebRequestBuilder(httpMethod, urlTemplate, urlVariables); return new DefaultClientWebRequestBuilder(httpMethod, urlTemplate, urlVariables);
} }
} }

2
src/asciidoc/web-reactive.adoc
View File

@ -132,7 +132,7 @@ Mono<Account> response = webClient
.extract(body(Account.class)); .extract(body(Account.class));
---- ----
The above assumes static method imports from `ClientWebRequestBuilder` and `ResponseExtractors` The above assumes static method imports from `ClientWebRequestBuilders` and `ResponseExtractors`
that enable a fluent syntax. The same can also be done with RxJava using static imports from that enable a fluent syntax. The same can also be done with RxJava using static imports from
`RxJava1ClientWebRequestBuilder` and `RxJava1ResponseExtractors` instead: `RxJava1ClientWebRequestBuilder` and `RxJava1ResponseExtractors` instead: