help.swgoh.api

Class SwgohAPIBuilder

java.lang.Object

help.swgoh.api.SwgohAPIBuilder

public class SwgohAPIBuilder
extends Object

This builder's sole purpose is to compile together the elements of a SwgohAPISettings object, which will be used to create an instance of the SwgohAPI interface.

Since:

1.0.0

Constructor Summary

Constructors

Constructor and Description
SwgohAPIBuilder()

Method Summary

Modifier and Type	Method and Description
SwgohAPI	build() Validate the SwgohAPISettings object and construct a new SwgohAPIClient instance with it.
SwgohAPIBuilder	withDefaultEnums(boolean enums) Defines the default behavior for the enums parameter if none is specified at the time of the request.
SwgohAPIBuilder	withDefaultLanguage(SwgohAPI.Language language) Defines the default language to use if none is specified at the time of the request.
SwgohAPIBuilder	withPassword(String password) Defines the password to be sent with the login request.
SwgohAPIBuilder	withUsername(String username) Defines the username to be sent with the login request.

Methods inherited from class java.lang.Object

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

Constructor Detail

SwgohAPIBuilder

public SwgohAPIBuilder()

Method Detail

withUsername

public SwgohAPIBuilder withUsername(String username)

Defines the username to be sent with the login request.

Parameters:

username - The username to be sent with the login request

Returns:

The builder instance.

withPassword

public SwgohAPIBuilder withPassword(String password)

Defines the password to be sent with the login request.

Parameters:

password - The password to be sent with the login request

Returns:

The builder instance.

withDefaultLanguage

public SwgohAPIBuilder withDefaultLanguage(SwgohAPI.Language language)

Defines the default language to use if none is specified at the time of the request.

Parameters:

language - The language to use for all API requests, unless overridden at the call level.

Returns:

The builder instance.

withDefaultEnums

public SwgohAPIBuilder withDefaultEnums(boolean enums)

Defines the default behavior for the enums parameter if none is specified at the time of the request.

Parameters:

enums - The default value of the enums parameter to use for all API requests, unless overridden at the call level.

Returns:

The builder instance.

build

public SwgohAPI build()

Validate the SwgohAPISettings object and construct a new SwgohAPIClient instance with it.

Returns:

The new client with the configuration specified by this builder.

Throws:

SwgohAPIException - if the validation of the settings object fails.

See Also:

SwgohAPISettings.validate()