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

Merge pull request #31659 from Johannes-Rost 

* pr/31659:
  Polish "Polish RestClient Javadoc"
  Polish RestClient Javadoc

Closes gh-31659
This commit is contained in:
Stéphane Nicoll 2023-11-23 13:01:37 +01:00
parent 52b40ffb03 487dbf8140
commit 16c6376b3f
1 changed files with 8 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
spring-web/src/main/java/org/springframework/web/client/RestClient.java
View File

@ -128,7 +128,7 @@ public interface RestClient {
/** /**
* Return a builder to create a new {@code RestClient} whose settings are * Return a builder to create a new {@code RestClient} whose settings are
* replicated from the current {@code RestClient}. * replicated from this {@code RestClient}.
*/ */
Builder mutate(); Builder mutate();
@ -468,8 +468,6 @@ public interface RestClient {
/** /**
* Set the value of the {@code If-Modified-Since} header. * Set the value of the {@code If-Modified-Since} header.
* <p>The date should be specified as the number of milliseconds since
* January 1, 1970 GMT.
* @param ifModifiedSince the new value of the header * @param ifModifiedSince the new value of the header
* @return this builder * @return this builder
*/ */
@ -673,26 +671,26 @@ public interface RestClient {
* .retrieve() * .retrieve()
* .toBodilessEntity(); * .toBodilessEntity();
* </pre> * </pre>
* @param body the body of the response * @param body the body of the request
* @return the built response * @return this builder
*/ */
RequestBodySpec body(Object body); RequestBodySpec body(Object body);
/** /**
* Set the body of the response to the given {@code Object}. * Set the body of the request to the given {@code Object}.
* The parameter {@code bodyType} is used to capture the generic type. * The parameter {@code bodyType} is used to capture the generic type.
* @param body the body of the response * @param body the body of the request
* @param bodyType the type of the body, used to capture the generic type * @param bodyType the type of the body, used to capture the generic type
* @return the built response * @return this builder
*/ */
<T> RequestBodySpec body(T body, ParameterizedTypeReference<T> bodyType); <T> RequestBodySpec body(T body, ParameterizedTypeReference<T> bodyType);
/** /**
* Set the body of the response to the given function that writes to * Set the body of the request to the given function that writes to
* an {@link OutputStream}. * an {@link OutputStream}.
* @param body a function that takes an {@code OutputStream} and can * @param body a function that takes an {@code OutputStream} and can
* throw an {@code IOException} * throw an {@code IOException}
* @return the built response * @return this builder
*/ */
RequestBodySpec body(StreamingHttpOutputMessage.Body body); RequestBodySpec body(StreamingHttpOutputMessage.Body body);
} }