Apache
/
httpcomponents-client
mirror of https://github.com/apache/httpcomponents-client.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Javadoc improvements 

- No need to use a FQCN when the name is already importted
- Import type instead of using a FQCN
- Use camel-case in paramerter name
- Add missing Javadoc
- Add some missing return tags
- Close some HTML tags
- Fix some comments
- Update Javadoc links
This commit is contained in:
Gary Gregory 2024-08-17 14:27:07 -04:00
parent 75aabd7f62
commit bc9f902bc0
8 changed files with 99 additions and 99 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
httpclient5/src/main/java/org/apache/hc/client5/http/impl/async/H2AsyncClientBuilder.java
View File

@ -265,7 +265,7 @@ public class H2AsyncClientBuilder {
} }
/** /**
* Assigns {@link AuthenticationStrategy} instance for target * Sets {@link AuthenticationStrategy} instance for target
* host authentication. * host authentication.
* *
* @return this instance. * @return this instance.
@ -277,7 +277,7 @@ public class H2AsyncClientBuilder {
} }
/** /**
* Assigns {@link AuthenticationStrategy} instance for proxy * Sets {@link AuthenticationStrategy} instance for proxy
* authentication. * authentication.
* *
* @return this instance. * @return this instance.
@ -445,7 +445,7 @@ public class H2AsyncClientBuilder {
} }
/** /**
* Assigns {@link HttpRequestRetryStrategy} instance. * Sets {@link HttpRequestRetryStrategy} instance.
* <p> * <p>
* Please note this value can be overridden by the {@link #disableAutomaticRetries()} * Please note this value can be overridden by the {@link #disableAutomaticRetries()}
* method. * method.
@ -459,7 +459,7 @@ public class H2AsyncClientBuilder {
} }
/** /**
* Assigns {@link RedirectStrategy} instance. * Sets {@link RedirectStrategy} instance.
* <p> * <p>
* Please note this value can be overridden by the {@link #disableRedirectHandling()} * Please note this value can be overridden by the {@link #disableRedirectHandling()}
* method. * method.
@ -473,7 +473,7 @@ public class H2AsyncClientBuilder {
} }
/** /**
* Assigns {@link SchemePortResolver} instance. * Sets {@link SchemePortResolver} instance.
* *
* @return this instance. * @return this instance.
*/ */
@ -483,7 +483,7 @@ public class H2AsyncClientBuilder {
} }
/** /**
* Assigns {@link DnsResolver} instance. * Sets {@link DnsResolver} instance.
* *
* @return this instance. * @return this instance.
*/ */
@ -493,7 +493,7 @@ public class H2AsyncClientBuilder {
} }
/** /**
* Assigns {@link TlsStrategy} instance. * Sets {@link TlsStrategy} instance.
* *
* @return this instance. * @return this instance.
*/ */
@ -503,7 +503,7 @@ public class H2AsyncClientBuilder {
} }
/** /**
* Assigns {@link ThreadFactory} instance. * Sets {@link ThreadFactory} instance.
* *
* @return this instance. * @return this instance.
*/ */
@ -513,7 +513,7 @@ public class H2AsyncClientBuilder {
} }
/** /**
* Assigns {@code User-Agent} value. * Sets {@code User-Agent} value.
* *
* @return this instance. * @return this instance.
*/ */
@ -523,7 +523,7 @@ public class H2AsyncClientBuilder {
} }
/** /**
* Assigns default request header values. * Sets default request header values.
* *
* @return this instance. * @return this instance.
*/ */
@ -533,7 +533,7 @@ public class H2AsyncClientBuilder {
} }
/** /**
* Assigns {@link HttpRoutePlanner} instance. * Sets {@link HttpRoutePlanner} instance.
* *
* @return this instance. * @return this instance.
*/ */
@ -543,7 +543,7 @@ public class H2AsyncClientBuilder {
} }
/** /**
* Assigns default {@link CredentialsProvider} instance which will be used * Sets default {@link CredentialsProvider} instance which will be used
* for request execution if not explicitly set in the client execution * for request execution if not explicitly set in the client execution
* context. * context.
* *
@ -555,7 +555,7 @@ public class H2AsyncClientBuilder {
} }
/** /**
* Assigns default {@link org.apache.hc.client5.http.auth.AuthScheme} registry which will * Sets default {@link org.apache.hc.client5.http.auth.AuthScheme} registry which will
* be used for request execution if not explicitly set in the client execution * be used for request execution if not explicitly set in the client execution
* context. * context.
* *
@ -567,7 +567,7 @@ public class H2AsyncClientBuilder {
} }
/** /**
* Assigns default {@link org.apache.hc.client5.http.cookie.CookieSpec} registry * Sets default {@link org.apache.hc.client5.http.cookie.CookieSpec} registry
* which will be used for request execution if not explicitly set in the client * which will be used for request execution if not explicitly set in the client
* execution context. * execution context.
* *
@ -579,7 +579,7 @@ public class H2AsyncClientBuilder {
} }
/** /**
* Assigns default {@link CookieStore} instance which will be used for * Sets default {@link CookieStore} instance which will be used for
* request execution if not explicitly set in the client execution context. * request execution if not explicitly set in the client execution context.
* *
* @return this instance. * @return this instance.
@ -590,7 +590,7 @@ public class H2AsyncClientBuilder {
} }
/** /**
* Assigns default {@link RequestConfig} instance which will be used * Sets default {@link RequestConfig} instance which will be used
* for request execution if not explicitly set in the client execution * for request execution if not explicitly set in the client execution
* context. * context.
* *
@ -602,7 +602,7 @@ public class H2AsyncClientBuilder {
} }
/** /**
* Assigns {@link Resolver} for {@link ConnectionConfig} on a per host basis. * Sets {@link Resolver} for {@link ConnectionConfig} on a per host basis.
* *
* @return this instance. * @return this instance.
* @since 5.2 * @since 5.2
@ -613,7 +613,7 @@ public class H2AsyncClientBuilder {
} }
/** /**
* Assigns the same {@link ConnectionConfig} for all hosts. * Sets the same {@link ConnectionConfig} for all hosts.
* *
* @return this instance. * @return this instance.
* @since 5.2 * @since 5.2

38
httpclient5/src/main/java/org/apache/hc/client5/http/impl/async/HttpAsyncClientBuilder.java
View File

@ -300,7 +300,7 @@ public class HttpAsyncClientBuilder {
} }
/** /**
* Assigns {@link AsyncClientConnectionManager} instance. * Sets {@link AsyncClientConnectionManager} instance.
* *
* @return this instance. * @return this instance.
*/ */
@ -371,7 +371,7 @@ public class HttpAsyncClientBuilder {
} }
/** /**
* Assigns {@link ConnectionReuseStrategy} instance. * Sets {@link ConnectionReuseStrategy} instance.
* <p> * <p>
* Please note this strategy applies to HTTP/1.0 and HTTP/1.1 connections only * Please note this strategy applies to HTTP/1.0 and HTTP/1.1 connections only
* </p> * </p>
@ -384,7 +384,7 @@ public class HttpAsyncClientBuilder {
} }
/** /**
* Assigns {@link ConnectionKeepAliveStrategy} instance. * Sets {@link ConnectionKeepAliveStrategy} instance.
* *
* @return this instance. * @return this instance.
*/ */
@ -394,7 +394,7 @@ public class HttpAsyncClientBuilder {
} }
/** /**
* Assigns {@link UserTokenHandler} instance. * Sets {@link UserTokenHandler} instance.
* <p> * <p>
* Please note this value can be overridden by the {@link #disableConnectionState()} * Please note this value can be overridden by the {@link #disableConnectionState()}
* method. * method.
@ -408,7 +408,7 @@ public class HttpAsyncClientBuilder {
} }
/** /**
* Assigns {@link AuthenticationStrategy} instance for target * Sets {@link AuthenticationStrategy} instance for target
* host authentication. * host authentication.
* *
* @return this instance. * @return this instance.
@ -420,7 +420,7 @@ public class HttpAsyncClientBuilder {
} }
/** /**
* Assigns {@link AuthenticationStrategy} instance for proxy * Sets {@link AuthenticationStrategy} instance for proxy
* authentication. * authentication.
* *
* @return this instance. * @return this instance.
@ -576,7 +576,7 @@ public class HttpAsyncClientBuilder {
} }
/** /**
* Assigns {@link HttpRequestRetryStrategy} instance. * Sets {@link HttpRequestRetryStrategy} instance.
* <p> * <p>
* Please note this value can be overridden by the {@link #disableAutomaticRetries()} * Please note this value can be overridden by the {@link #disableAutomaticRetries()}
* method. * method.
@ -590,7 +590,7 @@ public class HttpAsyncClientBuilder {
} }
/** /**
* Assigns {@link RedirectStrategy} instance. * Sets {@link RedirectStrategy} instance.
* <p> * <p>
* Please note this value can be overridden by the {@link #disableRedirectHandling()} * Please note this value can be overridden by the {@link #disableRedirectHandling()}
* method. * method.
@ -604,7 +604,7 @@ public class HttpAsyncClientBuilder {
} }
/** /**
* Assigns {@link SchemePortResolver} instance. * Sets {@link SchemePortResolver} instance.
* *
* @return this instance. * @return this instance.
*/ */
@ -614,7 +614,7 @@ public class HttpAsyncClientBuilder {
} }
/** /**
* Assigns {@link ThreadFactory} instance. * Sets {@link ThreadFactory} instance.
* *
* @return this instance. * @return this instance.
*/ */
@ -624,7 +624,7 @@ public class HttpAsyncClientBuilder {
} }
/** /**
* Assigns {@code User-Agent} value. * Sets {@code User-Agent} value.
* *
* @return this instance. * @return this instance.
*/ */
@ -634,7 +634,7 @@ public class HttpAsyncClientBuilder {
} }
/** /**
* Assigns default request header values. * Sets default request header values.
* *
* @return this instance. * @return this instance.
*/ */
@ -658,7 +658,7 @@ public class HttpAsyncClientBuilder {
} }
/** /**
* Assigns default proxy value. * Sets default proxy value.
* <p> * <p>
* Please note this value can be overridden by the {@link #setRoutePlanner( * Please note this value can be overridden by the {@link #setRoutePlanner(
* HttpRoutePlanner)} method. * HttpRoutePlanner)} method.
@ -671,7 +671,7 @@ public class HttpAsyncClientBuilder {
} }
/** /**
* Assigns {@link HttpRoutePlanner} instance. * Sets {@link HttpRoutePlanner} instance.
* *
* @return this instance. * @return this instance.
*/ */
@ -681,7 +681,7 @@ public class HttpAsyncClientBuilder {
} }
/** /**
* Assigns default {@link CredentialsProvider} instance which will be used * Sets default {@link CredentialsProvider} instance which will be used
* for request execution if not explicitly set in the client execution * for request execution if not explicitly set in the client execution
* context. * context.
* *
@ -693,7 +693,7 @@ public class HttpAsyncClientBuilder {
} }
/** /**
* Assigns default {@link org.apache.hc.client5.http.auth.AuthScheme} registry which will * Sets default {@link org.apache.hc.client5.http.auth.AuthScheme} registry which will
* be used for request execution if not explicitly set in the client execution * be used for request execution if not explicitly set in the client execution
* context. * context.
* *
@ -705,7 +705,7 @@ public class HttpAsyncClientBuilder {
} }
/** /**
* Assigns default {@link org.apache.hc.client5.http.cookie.CookieSpec} registry * Sets default {@link org.apache.hc.client5.http.cookie.CookieSpec} registry
* which will be used for request execution if not explicitly set in the client * which will be used for request execution if not explicitly set in the client
* execution context. * execution context.
* *
@ -717,7 +717,7 @@ public class HttpAsyncClientBuilder {
} }
/** /**
* Assigns default {@link CookieStore} instance which will be used for * Sets default {@link CookieStore} instance which will be used for
* request execution if not explicitly set in the client execution context. * request execution if not explicitly set in the client execution context.
* *
* @return this instance. * @return this instance.
@ -728,7 +728,7 @@ public class HttpAsyncClientBuilder {
} }
/** /**
* Assigns default {@link RequestConfig} instance which will be used * Sets default {@link RequestConfig} instance which will be used
* for request execution if not explicitly set in the client execution * for request execution if not explicitly set in the client execution
* context. * context.
* *

44
httpclient5/src/main/java/org/apache/hc/client5/http/impl/classic/HttpClientBuilder.java
View File

@ -243,7 +243,7 @@ public class HttpClientBuilder {
} }
/** /**
* Assigns {@link HttpRequestExecutor} instance. * Sets {@link HttpRequestExecutor} instance.
* *
* @return this instance. * @return this instance.
*/ */
@ -253,7 +253,7 @@ public class HttpClientBuilder {
} }
/** /**
* Assigns {@link HttpClientConnectionManager} instance. * Sets {@link HttpClientConnectionManager} instance.
* *
* @return this instance. * @return this instance.
*/ */
@ -285,7 +285,7 @@ public class HttpClientBuilder {
} }
/** /**
* Assigns {@link ConnectionReuseStrategy} instance. * Sets {@link ConnectionReuseStrategy} instance.
* *
* @return this instance. * @return this instance.
*/ */
@ -296,7 +296,7 @@ public class HttpClientBuilder {
} }
/** /**
* Assigns {@link ConnectionKeepAliveStrategy} instance. * Sets {@link ConnectionKeepAliveStrategy} instance.
* *
* @return this instance. * @return this instance.
*/ */
@ -307,7 +307,7 @@ public class HttpClientBuilder {
} }
/** /**
* Assigns {@link AuthenticationStrategy} instance for target * Sets {@link AuthenticationStrategy} instance for target
* host authentication. * host authentication.
* *
* @return this instance. * @return this instance.
@ -319,7 +319,7 @@ public class HttpClientBuilder {
} }
/** /**
* Assigns {@link AuthenticationStrategy} instance for proxy * Sets {@link AuthenticationStrategy} instance for proxy
* authentication. * authentication.
* *
* @return this instance. * @return this instance.
@ -331,7 +331,7 @@ public class HttpClientBuilder {
} }
/** /**
* Assigns {@link UserTokenHandler} instance. * Sets {@link UserTokenHandler} instance.
* <p> * <p>
* Please note this value can be overridden by the {@link #disableConnectionState()} * Please note this value can be overridden by the {@link #disableConnectionState()}
* method. * method.
@ -355,7 +355,7 @@ public class HttpClientBuilder {
} }
/** /**
* Assigns {@link SchemePortResolver} instance. * Sets {@link SchemePortResolver} instance.
* *
* @return this instance. * @return this instance.
*/ */
@ -366,7 +366,7 @@ public class HttpClientBuilder {
} }
/** /**
* Assigns {@code User-Agent} value. * Sets {@code User-Agent} value.
* *
* @return this instance. * @return this instance.
*/ */
@ -376,7 +376,7 @@ public class HttpClientBuilder {
} }
/** /**
* Assigns default request header values. * Sets default request header values.
* *
* @return this instance. * @return this instance.
*/ */
@ -549,7 +549,7 @@ public class HttpClientBuilder {
} }
/** /**
* Assigns {@link HttpRequestRetryStrategy} instance. * Sets {@link HttpRequestRetryStrategy} instance.
* <p> * <p>
* Please note this value can be overridden by the {@link #disableAutomaticRetries()} * Please note this value can be overridden by the {@link #disableAutomaticRetries()}
* method. * method.
@ -573,7 +573,7 @@ public class HttpClientBuilder {
} }
/** /**
* Assigns default proxy value. * Sets default proxy value.
* <p> * <p>
* Please note this value can be overridden by the {@link #setRoutePlanner( * Please note this value can be overridden by the {@link #setRoutePlanner(
* org.apache.hc.client5.http.routing.HttpRoutePlanner)} method. * org.apache.hc.client5.http.routing.HttpRoutePlanner)} method.
@ -587,7 +587,7 @@ public class HttpClientBuilder {
} }
/** /**
* Assigns {@link HttpRoutePlanner} instance. * Sets {@link HttpRoutePlanner} instance.
*/ */
public final HttpClientBuilder setRoutePlanner(final HttpRoutePlanner routePlanner) { public final HttpClientBuilder setRoutePlanner(final HttpRoutePlanner routePlanner) {
this.routePlanner = routePlanner; this.routePlanner = routePlanner;
@ -595,7 +595,7 @@ public class HttpClientBuilder {
} }
/** /**
* Assigns {@link RedirectStrategy} instance. * Sets {@link RedirectStrategy} instance.
* <p> * <p>
* Please note this value can be overridden by the {@link #disableRedirectHandling()} * Please note this value can be overridden by the {@link #disableRedirectHandling()}
* method. * method.
@ -619,7 +619,7 @@ public class HttpClientBuilder {
} }
/** /**
* Assigns {@link ConnectionBackoffStrategy} instance. * Sets {@link ConnectionBackoffStrategy} instance.
* *
* @return this instance. * @return this instance.
*/ */
@ -630,7 +630,7 @@ public class HttpClientBuilder {
} }
/** /**
* Assigns {@link BackoffManager} instance. * Sets {@link BackoffManager} instance.
* *
* @return this instance. * @return this instance.
*/ */
@ -640,7 +640,7 @@ public class HttpClientBuilder {
} }
/** /**
* Assigns default {@link CookieStore} instance which will be used for * Sets default {@link CookieStore} instance which will be used for
* request execution if not explicitly set in the client execution context. * request execution if not explicitly set in the client execution context.
* *
* @return this instance. * @return this instance.
@ -651,7 +651,7 @@ public class HttpClientBuilder {
} }
/** /**
* Assigns default {@link CredentialsProvider} instance which will be used * Sets default {@link CredentialsProvider} instance which will be used
* for request execution if not explicitly set in the client execution * for request execution if not explicitly set in the client execution
* context. * context.
* *
@ -664,7 +664,7 @@ public class HttpClientBuilder {
} }
/** /**
* Assigns default {@link org.apache.hc.client5.http.auth.AuthScheme} registry which will * Sets default {@link org.apache.hc.client5.http.auth.AuthScheme} registry which will
* be used for request execution if not explicitly set in the client execution * be used for request execution if not explicitly set in the client execution
* context. * context.
* *
@ -677,7 +677,7 @@ public class HttpClientBuilder {
} }
/** /**
* Assigns default {@link org.apache.hc.client5.http.cookie.CookieSpec} registry which will * Sets default {@link org.apache.hc.client5.http.cookie.CookieSpec} registry which will
* be used for request execution if not explicitly set in the client execution * be used for request execution if not explicitly set in the client execution
* context. * context.
* *
@ -692,7 +692,7 @@ public class HttpClientBuilder {
/** /**
* Assigns a map of {@link org.apache.hc.client5.http.entity.InputStreamFactory}s * Sets a map of {@link org.apache.hc.client5.http.entity.InputStreamFactory}s
* to be used for automatic content decompression. * to be used for automatic content decompression.
* *
* @return this instance. * @return this instance.
@ -704,7 +704,7 @@ public class HttpClientBuilder {
} }
/** /**
* Assigns default {@link RequestConfig} instance which will be used * Sets default {@link RequestConfig} instance which will be used
* for request execution if not explicitly set in the client execution * for request execution if not explicitly set in the client execution
* context. * context.
* *

30
httpclient5/src/main/java/org/apache/hc/client5/http/impl/io/PoolingHttpClientConnectionManagerBuilder.java
View File

@ -102,7 +102,7 @@ public class PoolingHttpClientConnectionManagerBuilder {
} }
/** /**
* Assigns {@link HttpConnectionFactory} instance. * Sets {@link HttpConnectionFactory} instance.
* *
* @return this instance. * @return this instance.
*/ */
@ -113,7 +113,7 @@ public class PoolingHttpClientConnectionManagerBuilder {
} }
/** /**
* Assigns {@link org.apache.hc.client5.http.socket.LayeredConnectionSocketFactory} instance. * Sets {@link org.apache.hc.client5.http.socket.LayeredConnectionSocketFactory} instance.
* *
* @return this instance. * @return this instance.
* @deprecated Use {@link #setTlsSocketStrategy(TlsSocketStrategy)} * @deprecated Use {@link #setTlsSocketStrategy(TlsSocketStrategy)}
@ -127,7 +127,7 @@ public class PoolingHttpClientConnectionManagerBuilder {
} }
/** /**
* Assigns {@link TlsSocketStrategy} instance. * Sets {@link TlsSocketStrategy} instance.
* *
* @return this instance. * @return this instance.
*/ */
@ -137,7 +137,7 @@ public class PoolingHttpClientConnectionManagerBuilder {
} }
/** /**
* Assigns {@link DnsResolver} instance. * Sets {@link DnsResolver} instance.
* *
* @return this instance. * @return this instance.
*/ */
@ -147,7 +147,7 @@ public class PoolingHttpClientConnectionManagerBuilder {
} }
/** /**
* Assigns {@link SchemePortResolver} instance. * Sets {@link SchemePortResolver} instance.
* *
* @return this instance. * @return this instance.
*/ */
@ -157,7 +157,7 @@ public class PoolingHttpClientConnectionManagerBuilder {
} }
/** /**
* Assigns {@link PoolConcurrencyPolicy} value. * Sets {@link PoolConcurrencyPolicy} value.
* *
* @return this instance. * @return this instance.
*/ */
@ -167,7 +167,7 @@ public class PoolingHttpClientConnectionManagerBuilder {
} }
/** /**
* Assigns {@link PoolReusePolicy} value. * Sets {@link PoolReusePolicy} value.
* *
* @return this instance. * @return this instance.
*/ */
@ -177,7 +177,7 @@ public class PoolingHttpClientConnectionManagerBuilder {
} }
/** /**
* Assigns maximum total connection value. * Sets maximum total connection value.
* *
* @return this instance. * @return this instance.
*/ */
@ -187,7 +187,7 @@ public class PoolingHttpClientConnectionManagerBuilder {
} }
/** /**
* Assigns maximum connection per route value. * Sets maximum connection per route value.
* *
* @return this instance. * @return this instance.
*/ */
@ -197,7 +197,7 @@ public class PoolingHttpClientConnectionManagerBuilder {
} }
/** /**
* Assigns the same {@link SocketConfig} for all routes. * Sets the same {@link SocketConfig} for all routes.
* *
* @return this instance. * @return this instance.
*/ */
@ -207,7 +207,7 @@ public class PoolingHttpClientConnectionManagerBuilder {
} }
/** /**
* Assigns {@link Resolver} of {@link SocketConfig} on a per route basis. * Sets {@link Resolver} of {@link SocketConfig} on a per route basis.
* *
* @return this instance. * @return this instance.
* @since 5.2 * @since 5.2
@ -219,7 +219,7 @@ public class PoolingHttpClientConnectionManagerBuilder {
} }
/** /**
* Assigns the same {@link ConnectionConfig} for all routes. * Sets the same {@link ConnectionConfig} for all routes.
* *
* @return this instance. * @return this instance.
* @since 5.2 * @since 5.2
@ -230,7 +230,7 @@ public class PoolingHttpClientConnectionManagerBuilder {
} }
/** /**
* Assigns {@link Resolver} of {@link ConnectionConfig} on a per route basis. * Sets {@link Resolver} of {@link ConnectionConfig} on a per route basis.
* *
* @return this instance. * @return this instance.
* @since 5.2 * @since 5.2
@ -242,7 +242,7 @@ public class PoolingHttpClientConnectionManagerBuilder {
} }
/** /**
* Assigns the same {@link TlsConfig} for all hosts. * Sets the same {@link TlsConfig} for all hosts.
* *
* @return this instance. * @return this instance.
* @since 5.2 * @since 5.2
@ -253,7 +253,7 @@ public class PoolingHttpClientConnectionManagerBuilder {
} }
/** /**
* Assigns {@link Resolver} of {@link TlsConfig} on a per host basis. * Sets {@link Resolver} of {@link TlsConfig} on a per host basis.
* *
* @return this instance. * @return this instance.
* @since 5.2 * @since 5.2

22
httpclient5/src/main/java/org/apache/hc/client5/http/impl/nio/PoolingAsyncClientConnectionManagerBuilder.java
View File

@ -98,7 +98,7 @@ public class PoolingAsyncClientConnectionManagerBuilder {
} }
/** /**
* Assigns {@link TlsStrategy} instance for TLS connections. * Sets {@link TlsStrategy} instance for TLS connections.
* *
* @return this instance. * @return this instance.
*/ */
@ -109,7 +109,7 @@ public class PoolingAsyncClientConnectionManagerBuilder {
} }
/** /**
* Assigns {@link DnsResolver} instance. * Sets {@link DnsResolver} instance.
* *
* @return this instance. * @return this instance.
*/ */
@ -119,7 +119,7 @@ public class PoolingAsyncClientConnectionManagerBuilder {
} }
/** /**
* Assigns {@link SchemePortResolver} instance. * Sets {@link SchemePortResolver} instance.
* *
* @return this instance. * @return this instance.
*/ */
@ -129,7 +129,7 @@ public class PoolingAsyncClientConnectionManagerBuilder {
} }
/** /**
* Assigns {@link PoolConcurrencyPolicy} value. * Sets {@link PoolConcurrencyPolicy} value.
* *
* @return this instance. * @return this instance.
*/ */
@ -139,7 +139,7 @@ public class PoolingAsyncClientConnectionManagerBuilder {
} }
/** /**
* Assigns {@link PoolReusePolicy} value. * Sets {@link PoolReusePolicy} value.
* *
* @return this instance. * @return this instance.
*/ */
@ -149,7 +149,7 @@ public class PoolingAsyncClientConnectionManagerBuilder {
} }
/** /**
* Assigns maximum total connection value. * Sets maximum total connection value.
* *
* @return this instance. * @return this instance.
*/ */
@ -159,7 +159,7 @@ public class PoolingAsyncClientConnectionManagerBuilder {
} }
/** /**
* Assigns maximum connection per route value. * Sets maximum connection per route value.
* *
* @return this instance. * @return this instance.
*/ */
@ -169,7 +169,7 @@ public class PoolingAsyncClientConnectionManagerBuilder {
} }
/** /**
* Assigns the same {@link ConnectionConfig} for all routes. * Sets the same {@link ConnectionConfig} for all routes.
* *
* @return this instance. * @return this instance.
* @since 5.2 * @since 5.2
@ -180,7 +180,7 @@ public class PoolingAsyncClientConnectionManagerBuilder {
} }
/** /**
* Assigns {@link Resolver} of {@link ConnectionConfig} on a per route basis. * Sets {@link Resolver} of {@link ConnectionConfig} on a per route basis.
* *
* @return this instance. * @return this instance.
* @since 5.2 * @since 5.2
@ -192,7 +192,7 @@ public class PoolingAsyncClientConnectionManagerBuilder {
} }
/** /**
* Assigns the same {@link TlsConfig} for all hosts. * Sets the same {@link TlsConfig} for all hosts.
* *
* @return this instance. * @return this instance.
* @since 5.2 * @since 5.2
@ -203,7 +203,7 @@ public class PoolingAsyncClientConnectionManagerBuilder {
} }
/** /**
* Assigns {@link Resolver} of {@link TlsConfig} on a per host basis. * Sets {@link Resolver} of {@link TlsConfig} on a per host basis.
* *
* @return this instance. * @return this instance.
* @since 5.2 * @since 5.2

16
httpclient5/src/main/java/org/apache/hc/client5/http/ssl/ClientTlsStrategyBuilder.java
View File

@ -79,7 +79,7 @@ public class ClientTlsStrategyBuilder {
private boolean systemProperties; private boolean systemProperties;
/** /**
* Assigns {@link SSLContext} instance. * Sets {@link SSLContext} instance.
* *
* @return this instance. * @return this instance.
*/ */
@ -89,7 +89,7 @@ public class ClientTlsStrategyBuilder {
} }
/** /**
* Assigns enabled {@code TLS} versions. * Sets enabled {@code TLS} versions.
* *
* @return this instance. * @return this instance.
*/ */
@ -99,7 +99,7 @@ public class ClientTlsStrategyBuilder {
} }
/** /**
* Assigns enabled {@code TLS} versions. * Sets enabled {@code TLS} versions.
* *
* @return this instance. * @return this instance.
*/ */
@ -112,7 +112,7 @@ public class ClientTlsStrategyBuilder {
} }
/** /**
* Assigns enabled ciphers. * Sets enabled ciphers.
* *
* @return this instance. * @return this instance.
*/ */
@ -122,7 +122,7 @@ public class ClientTlsStrategyBuilder {
} }
/** /**
* Assigns {@link SSLBufferMode} value. * Sets {@link SSLBufferMode} value.
* *
* @return this instance. * @return this instance.
*/ */
@ -132,14 +132,14 @@ public class ClientTlsStrategyBuilder {
} }
/** /**
* Assigns {@link HostnameVerificationPolicy} value. * Sets {@link HostnameVerificationPolicy} value.
*/ */
public void setHostnameVerificationPolicy(final HostnameVerificationPolicy hostnameVerificationPolicy) { public void setHostnameVerificationPolicy(final HostnameVerificationPolicy hostnameVerificationPolicy) {
this.hostnameVerificationPolicy = hostnameVerificationPolicy; this.hostnameVerificationPolicy = hostnameVerificationPolicy;
} }
/** /**
* Assigns {@link HostnameVerifier} instance. * Sets {@link HostnameVerifier} instance.
* *
* @return this instance. * @return this instance.
*/ */
@ -149,7 +149,7 @@ public class ClientTlsStrategyBuilder {
} }
/** /**
* Assigns {@link TlsDetails} {@link Factory} instance. * Sets {@link TlsDetails} {@link Factory} instance.
* *
* @return this instance. * @return this instance.
* @deprecated Do not use. This method has no effect. * @deprecated Do not use. This method has no effect.

10
httpclient5/src/main/java/org/apache/hc/client5/http/ssl/SSLConnectionSocketFactoryBuilder.java
View File

@ -73,7 +73,7 @@ public class SSLConnectionSocketFactoryBuilder {
private boolean systemProperties; private boolean systemProperties;
/** /**
* Assigns {@link SSLContext} instance. * Sets {@link SSLContext} instance.
* *
* @return this instance. * @return this instance.
*/ */
@ -83,7 +83,7 @@ public class SSLConnectionSocketFactoryBuilder {
} }
/** /**
* Assigns enabled {@code TLS} versions. * Sets enabled {@code TLS} versions.
* *
* @return this instance. * @return this instance.
*/ */
@ -93,7 +93,7 @@ public class SSLConnectionSocketFactoryBuilder {
} }
/** /**
* Assigns enabled {@code TLS} versions. * Sets enabled {@code TLS} versions.
* *
* @return this instance. * @return this instance.
*/ */
@ -106,7 +106,7 @@ public class SSLConnectionSocketFactoryBuilder {
} }
/** /**
* Assigns enabled ciphers. * Sets enabled ciphers.
* *
* @return this instance. * @return this instance.
*/ */
@ -117,7 +117,7 @@ public class SSLConnectionSocketFactoryBuilder {
/** /**
* Assigns {@link HostnameVerifier} instance. * Sets {@link HostnameVerifier} instance.
* *
* @return this instance. * @return this instance.
*/ */