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

Improve javadoc of ClientHttpRequestFactories 

Closes gh-36267
This commit is contained in:
Andy Wilkinson 2023-07-06 19:42:17 +01:00
parent 7ae030adad
commit 4d70b83e80
1 changed files with 19 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
spring-boot-project/spring-boot/src/main/java/org/springframework/boot/web/client/ClientHttpRequestFactories.java
View File

@ -61,8 +61,14 @@ public final class ClientHttpRequestFactories {
} }
/** /**
* Return a new {@link ClientHttpRequestFactory} instance using the most appropriate * Return a {@link ClientHttpRequestFactory} implementation with the given
* implementation. * {@code settings} applied. The first of the following implementations whose
* dependencies {@link ClassUtils#isPresent are available} is returned:
* <ol>
* <li>{@link HttpComponentsClientHttpRequestFactory}</li>
* <li>{@link OkHttp3ClientHttpRequestFactory}</li>
* <li>{@link SimpleClientHttpRequestFactory}</li>
* </ol>
* @param settings the settings to apply * @param settings the settings to apply
* @return a new {@link ClientHttpRequestFactory} * @return a new {@link ClientHttpRequestFactory}
*/ */
@ -78,8 +84,17 @@ public final class ClientHttpRequestFactories {
} }
/** /**
* Return a new {@link ClientHttpRequestFactory} of the given type, applying * Return a new {@link ClientHttpRequestFactory} of the given
* {@link ClientHttpRequestFactorySettings} using reflection if necessary. * {@code requestFactoryType}, applying {@link ClientHttpRequestFactorySettings} using
* reflection if necessary. The following implementations are supported without the
* use of reflection:
* <ul>
* <li>{@link HttpComponentsClientHttpRequestFactory}</li>
* <li>{@link OkHttp3ClientHttpRequestFactory}</li>
* <li>{@link SimpleClientHttpRequestFactory}</li>
* </ul>
* A {@code requestFactoryType} of {@link ClientHttpRequestFactory} is equivalent to
* calling {@link #get(ClientHttpRequestFactorySettings)}.
* @param <T> the {@link ClientHttpRequestFactory} type * @param <T> the {@link ClientHttpRequestFactory} type
* @param requestFactoryType the {@link ClientHttpRequestFactory} type * @param requestFactoryType the {@link ClientHttpRequestFactory} type
* @param settings the settings to apply * @param settings the settings to apply