Package com.luciad.net.http

Class HttpRequestOptions

java.lang.Object

com.luciad.net.http.HttpRequestOptions

All Implemented Interfaces:

AutoCloseable

public final class HttpRequestOptions
extends Object
implements AutoCloseable

Options to be sent with an HTTP request.

This is a collection of HttpHeaders and UriQueryParameters. An HttpRequestOptions instance is built through an HttpResponse.Builder.

Since:

2023.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	HttpRequestOptions.Builder	Builder for the HttpRequestOptions class.

Constructor Summary

Constructors

Constructor	Description
HttpRequestOptions(HttpRequestOptions other)

Method Summary

Modifier and Type	Method	Description
HttpRequestOptions.Builder	asBuilder()	Returns an HttpRequestOptions builder that has all properties of this HttpRequestOptions.
void	close()
protected void	finalize()
List<@NotNull HttpHeader>	getHeaders()	Returns the HTTP headers for this request options instance.
List<@NotNull UriQueryParameter>	getQueryParameters()	Returns the query parameters for this request options instance.
static HttpRequestOptions.Builder	newBuilder()	Creates a new HttpRequestOptions builder.

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

HttpRequestOptions

public HttpRequestOptions(@NotNull
 HttpRequestOptions other)

Method Details

finalize

protected void finalize()

Overrides:

finalize in class Object

close

public void close()

Specified by:

close in interface AutoCloseable

newBuilder

@NotNull
public static HttpRequestOptions.Builder newBuilder()

Creates a new HttpRequestOptions builder.

Returns:

a new HttpRequestOptions builder.

asBuilder

@NotNull
public HttpRequestOptions.Builder asBuilder()

Returns an HttpRequestOptions builder that has all properties of this HttpRequestOptions.

Returns:

an HttpRequestOptions builder that has all properties of this HttpRequestOptions.

getHeaders

@NotNull
public List<@NotNull HttpHeader> getHeaders()

Returns the HTTP headers for this request options instance.

Returns:

the HTTP headers for this request options instance.

getQueryParameters

@NotNull
public List<@NotNull UriQueryParameter> getQueryParameters()

Returns the query parameters for this request options instance.

Returns:

the query parameters for this request options instance.