Package org.eu.zajc.akiwrapper

Class AkiwrapperBuilder

java.lang.Object

org.eu.zajc.akiwrapper.AkiwrapperBuilder

public class AkiwrapperBuilder
extends Object

A class used to build an Akiwrapper object.

Author:

Marko Zajc

Field Summary

Fields

Modifier and Type	Field	Description
static final boolean	DEFAULT_FILTER_PROFANITY	The default profanity filter preference for new Akiwrapper instances.
static final Akiwrapper.Theme	DEFAULT_GUESS_TYPE	Deprecated, for removal: This API element is subject to removal in a future version. Use DEFAULT_THEME instead
static final Akiwrapper.Language	DEFAULT_LANGUAGE	The default Akiwrapper.Language for new Akiwrapper instances.
static final Akiwrapper.Theme	DEFAULT_THEME	The default Akiwrapper.Theme for new Akiwrapper instances.

Constructor Summary

Constructors

Constructor	Description
AkiwrapperBuilder()	Creates a new AkiwrapperBuilder with the following defaults: profanity filtering is set to false (DEFAULT_FILTER_PROFANITY), language is set to Akiwrapper.Language.ENGLISH (DEFAULT_LANGUAGE), theme is set to Akiwrapper.Theme.CHARACTER (DEFAULT_GUESS_TYPE),

Method Summary

Modifier and Type	Method	Description
Akiwrapper	build()	Creates a new Akiwrapper instance from your preferences.
boolean	doesFilterProfanity()	Returns the profanity filter preference.
Akiwrapper.Theme	getGuessType()	Deprecated, for removal: This API element is subject to removal in a future version. Use getTheme() instead.
Akiwrapper.Language	getLanguage()	Note: while all Akiwrapper.Languages support Akiwrapper.Theme.CHARACTER, but other themes might not be supported.
Akiwrapper.Theme	getTheme()	Note: while all Akiwrapper.Languages support Akiwrapper.Theme.CHARACTER, but other themes might not be supported.
kong.unirest.UnirestInstance	getUnirestInstance()	Returns the UnirestInstance to be used by the built Akiwrapper instance.
AkiwrapperBuilder	setFilterProfanity(boolean filterProfanity)	Sets the profanity filter preference.
AkiwrapperBuilder	setGuessType(Akiwrapper.Theme theme)	Deprecated, for removal: This API element is subject to removal in a future version. Use setTheme(Theme) instead
AkiwrapperBuilder	setLanguage(Akiwrapper.Language language)	Note: while all Akiwrapper.Languages support Akiwrapper.Theme.CHARACTER, but other themes might not be supported.
AkiwrapperBuilder	setTheme(Akiwrapper.Theme theme)	Note: while all Akiwrapper.Languages support Akiwrapper.Theme.CHARACTER, but other themes might not be supported.
AkiwrapperBuilder	setUnirestInstance(kong.unirest.UnirestInstance unirest)	Sets the UnirestInstance to be used by the built Akiwrapper instance.

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_FILTER_PROFANITY

public static final boolean DEFAULT_FILTER_PROFANITY

The default profanity filter preference for new Akiwrapper instances.

See Also:

• Constant Field Values

DEFAULT_LANGUAGE

@Nonnull
public static final Akiwrapper.Language DEFAULT_LANGUAGE

The default Akiwrapper.Language for new Akiwrapper instances.

DEFAULT_THEME

@Nonnull
public static final Akiwrapper.Theme DEFAULT_THEME

The default Akiwrapper.Theme for new Akiwrapper instances.

DEFAULT_GUESS_TYPE

@Deprecated(since="2.0",
            forRemoval=true)
@Nonnull
public static final Akiwrapper.Theme DEFAULT_GUESS_TYPE

Deprecated, for removal: This API element is subject to removal in a future version.

Use DEFAULT_THEME instead

The default Akiwrapper.Theme for new Akiwrapper instances.

Constructor Details

AkiwrapperBuilder

public AkiwrapperBuilder()

Creates a new AkiwrapperBuilder with the following defaults:

• profanity filtering is set to false (DEFAULT_FILTER_PROFANITY),
• language is set to Akiwrapper.Language.ENGLISH (DEFAULT_LANGUAGE),
• theme is set to Akiwrapper.Theme.CHARACTER (DEFAULT_GUESS_TYPE),

Method Details

setUnirestInstance

@Nonnull
public AkiwrapperBuilder setUnirestInstance(@Nullable
 kong.unirest.UnirestInstance unirest)

Sets the UnirestInstance to be used by the built Akiwrapper instance. Note that Akinator's services are quite picky about the HTTP client configuration, so you will very likely need to put your instance through UnirestUtils.configureInstance(UnirestInstance) before using it with Akiwrapper. You will also need to shut it down yourself, or, if you decide to set or leave this on {$code null}, call UnirestUtils.shutdownInstance() to shut down Akiwrapper's default singleton instance, otherwise its threads will stay alive.

Parameters:

unirest - the UnirestInstance to be used by Akiwrapper or {$code null} to use UnirestUtils.getInstance().

Returns:

current instance, used for chaining.

See Also:

• UnirestUtils.getInstance()

getUnirestInstance

@Nullable
public kong.unirest.UnirestInstance getUnirestInstance()

Returns the UnirestInstance to be used by the built Akiwrapper instance. If this is {$code null}, UnirestUtils.getInstance() will be used (which means you will need to shut it down through UnirestUtils.shutdownInstance(), otherwise its threads will stay alive).

Returns:

UnirestInstance to be used or {$code null} for UnirestUtils.getInstance().

setFilterProfanity

@Nonnull
public AkiwrapperBuilder setFilterProfanity(boolean filterProfanity)

Sets the profanity filter preference. Profanity filtering is done by Akinator and not by Akiwrapper. Keep in mind that Akinator's filters aren't perfect, so explicit Query objects can still be returned.
This is set to false by default.

Parameters:

filterProfanity -

Returns:

current instance, used for chaining.

See Also:

• doesFilterProfanity()

doesFilterProfanity

public boolean doesFilterProfanity()

Returns the profanity filter preference. Profanity filtering is done by Akinator and not by Akiwrapper. Keep in mind that Akinator's filters aren't perfect, so explicit Query objects can still be returned.
This is set to false by default.

Returns:

profanity filter preference.

setLanguage

@Nonnull
public AkiwrapperBuilder setLanguage(@Nonnull
 Akiwrapper.Language language)

Note: while all Akiwrapper.Languages support Akiwrapper.Theme.CHARACTER, but other themes might not be supported. Call Akiwrapper.Language.getSupportedThemes() for a list of supported themes.
Sets the Akiwrapper.Language. Akinator will return localized Query objects depending on this preference.
This is set to Akiwrapper.Language.ENGLISH by default.

Parameters:

language -

Returns:

current instance, used for chaining.

See Also:

• getLanguage()

getLanguage

@Nonnull
public Akiwrapper.Language getLanguage()

Note: while all Akiwrapper.Languages support Akiwrapper.Theme.CHARACTER, but other themes might not be supported. Call Akiwrapper.Language.getSupportedThemes() for a list of supported themes.
Sets the Akiwrapper.Language. Akinator will return localized Query objects depending on this preference.
This is set to Akiwrapper.Language.ENGLISH by default.

Returns:

language preference.

See Also:

• setLanguage(Language)

setTheme

@Nonnull
public AkiwrapperBuilder setTheme(@Nonnull
 Akiwrapper.Theme theme)

Note: while all Akiwrapper.Languages support Akiwrapper.Theme.CHARACTER, but other themes might not be supported. Call Akiwrapper.Language.getSupportedThemes() for a list of supported themes.
Sets the Akiwrapper.Theme. This decides the theme of Akinator's Query objects.
This is set to Akiwrapper.Theme.CHARACTER by default.

Parameters:

theme -

Returns:

current instance, used for chaining.

See Also:

• getTheme()

setGuessType

@Nonnull
@Deprecated(since="2.0",
            forRemoval=true)
public AkiwrapperBuilder setGuessType(@Nonnull
 Akiwrapper.Theme theme)

Deprecated, for removal: This API element is subject to removal in a future version.

Use setTheme(Theme) instead

Note: while all Akiwrapper.Languages support Akiwrapper.Theme.CHARACTER, but other themes might not be supported. Call Akiwrapper.Language.getSupportedThemes() for a list of supported themes.
Sets the Akiwrapper.Theme. This decides the theme of Akinator's Query objects.
This is set to Akiwrapper.Theme.CHARACTER by default.

Parameters:

theme -

Returns:

current instance, used for chaining.

See Also:

• getGuessType()

getTheme

@Nonnull
public Akiwrapper.Theme getTheme()

Note: while all Akiwrapper.Languages support Akiwrapper.Theme.CHARACTER, but other themes might not be supported. Call Akiwrapper.Language.getSupportedThemes() for a list of supported themes.
Sets the Akiwrapper.Theme. This decides the theme of Akinator's Query objects.
This is set to Akiwrapper.Theme.CHARACTER by default.

Returns:

theme preference.

See Also:

• setTheme(Theme)

getGuessType

@Nonnull
@Deprecated(since="2.0",
            forRemoval=true)
public Akiwrapper.Theme getGuessType()

Deprecated, for removal: This API element is subject to removal in a future version.

Use getTheme() instead.

Note: while all Akiwrapper.Languages support Akiwrapper.Theme.CHARACTER, but other themes might not be supported. Call Akiwrapper.Language.getSupportedThemes() for a list of supported themes.
Sets the Akiwrapper.Theme. This decides the theme of Akinator's Query objects.
This is set to Akiwrapper.Theme.CHARACTER by default.

Returns:

theme preference.

See Also:

• setGuessType(Theme)

build

@Nonnull
public Akiwrapper build()
                 throws LanguageThemeCombinationException

Creates a new Akiwrapper instance from your preferences. If no UnirestInstance was set (with setUnirestInstance(UnirestInstance)), a singleton instance will be acquired from UnirestUtils.getInstance(). This instance must be shut down after you're done using Akiwrapper with UnirestUtils.shutdownInstance(), otherwise its threads will stay alive.

Returns:

a new Akiwrapper instance.

Throws:

LanguageThemeCombinationException - if the Akiwrapper.Language and Akiwrapper.Theme combination is incompatible.