Package com.luciad.net.http

Class HttpResponse.Builder

java.lang.Object

com.luciad.net.http.HttpResponse.Builder

All Implemented Interfaces:

AutoCloseable

Enclosing class:

HttpResponse

public static final class HttpResponse.Builder
extends Object
implements AutoCloseable

Builder for the HttpResponse class.

Instances of HttpRequest.Builder are created by calling HttpResponse#newBuilder.

Since:

2023.0

Constructor Summary

Constructors

Constructor	Description
Builder(HttpResponse.Builder other)

Method Summary

Modifier and Type	Method	Description
HttpResponse.Builder	body(DataEntity body)	Sets the HTTP response content.
HttpResponse	build()	Returns an HttpResponse based on the properties set on this builder.
void	close()
protected void	finalize()
HttpResponse.Builder	header(HttpHeader header)	Sets the given http header to the set of headers for this response.
HttpResponse.Builder	header(String name, String value)	Sets the given name value pair to the set of headers for this response.
HttpResponse.Builder	statusCode(int statusCode)	Sets the status code of the HTTP response.

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder(@NotNull
 HttpResponse.Builder other)

Method Details

finalize

protected void finalize()

Overrides:

finalize in class Object

close

public void close()

Specified by:

close in interface AutoCloseable

build

@NotNull
public HttpResponse build()
                   throws IllegalStateException

Returns an HttpResponse based on the properties set on this builder.

Returns:

an HttpResponse.

Throws:

IllegalStateException - if the status code for this response has not been set.

statusCode

@NotNull
public HttpResponse.Builder statusCode(int statusCode)

Sets the status code of the HTTP response.

This parameter is mandatory. If it is not set, HttpResponse.Builder#build will throw an exception.

Parameters:

statusCode - the status code for this response.

Returns:

this builder.

body

@NotNull
public HttpResponse.Builder body(@NotNull
 DataEntity body)

Sets the HTTP response content.

This parameter is optional.

Parameters:

body - the response content.

Returns:

this builder.

header

@NotNull
public HttpResponse.Builder header(@NotNull
 String name,
 @NotNull
 String value)

Sets the given name value pair to the set of headers for this response.

Parameters:

name - header name

value - header value

Returns:

this builder.

header

@NotNull
public HttpResponse.Builder header(@NotNull
 HttpHeader header)

Sets the given http header to the set of headers for this response.

Parameters:

header - an HttpHeader.

Returns:

this builder.