Package ru.easydonate.easydonate4j.api.v3.client

Interface EasyDonateClient.Builder

Enclosing interface:

EasyDonateClient

public static interface EasyDonateClient.Builder

The EasyDonate API client instance builder.

Author:

soknight

Method Summary

Modifier and Type	Method	Description
@NotNull EasyDonateClient	create()	Create the API client instance with current specification.
@NotNull EasyDonateClient.Builder	setAccessKey(@NotNull String accessKey)	Set the shop access key.
@NotNull EasyDonateClient.Builder	setConnectTimeout(long timeout, @NotNull TimeUnit timeUnit)	Set the connection establishing timeout.
@NotNull EasyDonateClient.Builder	setReadTimeout(long timeout, @NotNull TimeUnit timeUnit)	Set the response awaiting and reading timeout.
@NotNull EasyDonateClient.Builder	setResponseTimeout(long timeout, @NotNull TimeUnit timeUnit)	Set the response awaiting timeout.
@NotNull EasyDonateClient.Builder	setUserAgent(@NotNull String userAgent)	Set the custom User-Agent header value for all further HTTP requests. The default User-Agent is determined by Constants.USER_AGENT.
@NotNull EasyDonateClient.Builder	setWriteTimeout(long timeout, @NotNull TimeUnit timeUnit)	Set the request writing and sending timeout.

Method Detail

create

@NotNull
@NotNull EasyDonateClient create()

Create the API client instance with current specification.

Returns:

The created API client instance.

setAccessKey

@NotNull
@NotNull EasyDonateClient.Builder setAccessKey(@NotNull
                                               @NotNull String accessKey)

Set the shop access key.

Parameters:

accessKey - a new shop access key.

Returns:

The builder instance for method chaining continuation.

setConnectTimeout

@NotNull
@NotNull EasyDonateClient.Builder setConnectTimeout(long timeout,
                                                    @NotNull
                                                    @NotNull TimeUnit timeUnit)

Set the connection establishing timeout.

Parameters:

timeout - a digital timeout value.

timeUnit - the time unit of the specified value.

Returns:

The builder instance for method chaining continuation.

setResponseTimeout

@NotNull
@NotNull EasyDonateClient.Builder setResponseTimeout(long timeout,
                                                     @NotNull
                                                     @NotNull TimeUnit timeUnit)

Set the response awaiting timeout.

Parameters:

timeout - a digital timeout value.

timeUnit - the time unit of the specified value.

Returns:

The builder instance for method chaining continuation.

setReadTimeout

@NotNull
@NotNull EasyDonateClient.Builder setReadTimeout(long timeout,
                                                 @NotNull
                                                 @NotNull TimeUnit timeUnit)

Set the response awaiting and reading timeout.

Parameters:

timeout - a digital timeout value.

timeUnit - the time unit of the specified value.

Returns:

The builder instance for method chaining continuation.

setWriteTimeout

@NotNull
@NotNull EasyDonateClient.Builder setWriteTimeout(long timeout,
                                                  @NotNull
                                                  @NotNull TimeUnit timeUnit)

Set the request writing and sending timeout.

Parameters:

timeout - a digital timeout value.

timeUnit - the time unit of the specified value.

Returns:

The builder instance for method chaining continuation.

setUserAgent

@NotNull
@NotNull EasyDonateClient.Builder setUserAgent(@NotNull
                                               @NotNull String userAgent)

Set the custom User-Agent header value for all further HTTP requests.
The default User-Agent is determined by Constants.USER_AGENT.

Parameters:

userAgent - a new User-Agent header value.

Returns:

The builder instance for method chaining continuation.