Spring/spring-framework
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

MultipartBodyBuilder Javadoc update

Browse Source 
Closes gh-24031
This commit is contained in:
Rossen Stoyanchev
2019-11-28 10:40:28 +00:00
parent d8f7ed133f
commit df2ed75df0
1 changed files with 14 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -39,11 +39,21 @@ import org.springframework.util.LinkedMultiValueMap;
import org.springframework.util.MultiValueMap; import org.springframework.util.MultiValueMap;
/** /**
* Builder for the body of a multipart request, producing * Prepare the body of a multipart request, resulting in a
* {@code MultiValueMap<String, HttpEntity>}, which can be provided to the * {@code MultiValueMap<String, HttpEntity>}. Parts may be concrete values or
* {@code WebClient} through the {@code body} method. * via asynchronous types such as Reactor {@code Mono}, {@code Flux}, and
* others registered in the
* {@link org.springframework.core.ReactiveAdapterRegistry ReactiveAdapterRegistry}.
* *
* Examples: * <p>This builder is intended for use with the reactive
* {@link org.springframework.web.reactive.function.client.WebClient WebClient}.
* For multipart requests with the {@code RestTemplate}, simply create and
* populate a {@code MultiValueMap<String, HttpEntity>} as shown in the Javadoc for
* {@link org.springframework.http.converter.FormHttpMessageConverter FormHttpMessageConverter}
* and in the
* <a href="https://docs.spring.io/spring/docs/current/spring-framework-reference/integration.html#rest-template-multipart">reference docs</a>.
*
* <p>Below are examples of using this builder:
* <pre class="code"> * <pre class="code">
* *
* // Add form field * // Add form field