8281223: Improve the API documentation of HttpRequest.Builder::build to state that the default implementation provided by the JDK returns immutable objects.

Reviewed-by: dfuchs, jpai, chegar
This commit is contained in:
Conor Cleary 2022-03-31 04:28:22 +00:00 committed by Jaikiran Pai
parent eeca3a3155
commit e0a86699b3

@ -292,6 +292,10 @@ public abstract class HttpRequest {
/**
* Builds and returns an {@link HttpRequest}.
*
* @implSpec This method returns a new {@code HttpRequest} each time it is
* invoked. Once built, the {@code HttpRequest} is immutable and can be
* sent multiple times.
*
* @return a new {@code HttpRequest}
* @throws IllegalStateException if a URI has not been set
*/