Skip to content

Commit aeec124

Browse files
committed
ClientWebRequestBuilders documentation fix
Issue: SPR-14561
1 parent 5531e80 commit aeec124

File tree

2 files changed

+11
-20
lines changed

2 files changed

+11
-20
lines changed

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

Lines changed: 10 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,6 @@
1616

1717
package org.springframework.web.client.reactive;
1818

19-
2019
import org.springframework.http.HttpMethod;
2120

2221
/**
@@ -30,8 +29,7 @@ public abstract class ClientWebRequestBuilders {
3029

3130
/**
3231
* Create a {@link DefaultClientWebRequestBuilder} for a GET request.
33-
*
34-
* @param urlTemplate a URL template; the resulting URL will be encoded
32+
* @param urlTemplate a URL template; the resulting URL will be encoded
3533
* @param urlVariables zero or more URL variables
3634
*/
3735
public static DefaultClientWebRequestBuilder get(String urlTemplate, Object... urlVariables) {
@@ -40,8 +38,7 @@ public static DefaultClientWebRequestBuilder get(String urlTemplate, Object... u
4038

4139
/**
4240
* Create a {@link DefaultClientWebRequestBuilder} for a POST request.
43-
*
44-
* @param urlTemplate a URL template; the resulting URL will be encoded
41+
* @param urlTemplate a URL template; the resulting URL will be encoded
4542
* @param urlVariables zero or more URL variables
4643
*/
4744
public static DefaultClientWebRequestBuilder post(String urlTemplate, Object... urlVariables) {
@@ -50,8 +47,7 @@ public static DefaultClientWebRequestBuilder post(String urlTemplate, Object...
5047

5148
/**
5249
* Create a {@link DefaultClientWebRequestBuilder} for a PUT request.
53-
*
54-
* @param urlTemplate a URL template; the resulting URL will be encoded
50+
* @param urlTemplate a URL template; the resulting URL will be encoded
5551
* @param urlVariables zero or more URL variables
5652
*/
5753
public static DefaultClientWebRequestBuilder put(String urlTemplate, Object... urlVariables) {
@@ -60,8 +56,7 @@ public static DefaultClientWebRequestBuilder put(String urlTemplate, Object... u
6056

6157
/**
6258
* Create a {@link DefaultClientWebRequestBuilder} for a PATCH request.
63-
*
64-
* @param urlTemplate a URL template; the resulting URL will be encoded
59+
* @param urlTemplate a URL template; the resulting URL will be encoded
6560
* @param urlVariables zero or more URL variables
6661
*/
6762
public static DefaultClientWebRequestBuilder patch(String urlTemplate, Object... urlVariables) {
@@ -70,8 +65,7 @@ public static DefaultClientWebRequestBuilder patch(String urlTemplate, Object...
7065

7166
/**
7267
* Create a {@link DefaultClientWebRequestBuilder} for a DELETE request.
73-
*
74-
* @param urlTemplate a URL template; the resulting URL will be encoded
68+
* @param urlTemplate a URL template; the resulting URL will be encoded
7569
* @param urlVariables zero or more URL variables
7670
*/
7771
public static DefaultClientWebRequestBuilder delete(String urlTemplate, Object... urlVariables) {
@@ -80,8 +74,7 @@ public static DefaultClientWebRequestBuilder delete(String urlTemplate, Object..
8074

8175
/**
8276
* Create a {@link DefaultClientWebRequestBuilder} for an OPTIONS request.
83-
*
84-
* @param urlTemplate a URL template; the resulting URL will be encoded
77+
* @param urlTemplate a URL template; the resulting URL will be encoded
8578
* @param urlVariables zero or more URL variables
8679
*/
8780
public static DefaultClientWebRequestBuilder options(String urlTemplate, Object... urlVariables) {
@@ -90,8 +83,7 @@ public static DefaultClientWebRequestBuilder options(String urlTemplate, Object.
9083

9184
/**
9285
* Create a {@link DefaultClientWebRequestBuilder} for a HEAD request.
93-
*
94-
* @param urlTemplate a URL template; the resulting URL will be encoded
86+
* @param urlTemplate a URL template; the resulting URL will be encoded
9587
* @param urlVariables zero or more URL variables
9688
*/
9789
public static DefaultClientWebRequestBuilder head(String urlTemplate, Object... urlVariables) {
@@ -100,13 +92,12 @@ public static DefaultClientWebRequestBuilder head(String urlTemplate, Object...
10092

10193
/**
10294
* Create a {@link DefaultClientWebRequestBuilder} for a request with the given HTTP method.
103-
*
104-
* @param httpMethod the HTTP method
105-
* @param urlTemplate a URL template; the resulting URL will be encoded
95+
* @param httpMethod the HTTP method
96+
* @param urlTemplate a URL template; the resulting URL will be encoded
10697
* @param urlVariables zero or more URL variables
10798
*/
10899
public static DefaultClientWebRequestBuilder request(HttpMethod httpMethod, String urlTemplate, Object... urlVariables) {
109100
return new DefaultClientWebRequestBuilder(httpMethod, urlTemplate, urlVariables);
110101
}
111102

112-
}
103+
}

src/asciidoc/web-reactive.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -132,7 +132,7 @@ Mono<Account> response = webClient
132132
.extract(body(Account.class));
133133
----
134134

135-
The above assumes static method imports from `ClientWebRequestBuilder` and `ResponseExtractors`
135+
The above assumes static method imports from `ClientWebRequestBuilders` and `ResponseExtractors`
136136
that enable a fluent syntax. The same can also be done with RxJava using static imports from
137137
`RxJava1ClientWebRequestBuilder` and `RxJava1ResponseExtractors` instead:
138138

0 commit comments

Comments
 (0)