Package org.eu.zajc.akiwrapper.core.entities

Interface Question

All Superinterfaces:

Query

All Known Implementing Classes:

QuestionImpl

public interface Question
extends Query

A type of Query that represents Akinator's question. Questions are answered with answer(Answer) (incrementing the step or undone with undoAnswer() (decrementing the step). Besides the question text, questions also come with an "akitude" picture, a portmanteau of "Akinator" and "attitude", which can be shown to the user.
Note: A single Question object can only be interacted with once. Calling answer(Answer) or undoAnswer() mutates the session state, so you can only call one of them once.

Author:

Marko Zajc

Method Summary

Modifier and Type	Method	Description
Query	answer(Akiwrapper.Answer answer)	This is an interaction method for Question. Submits an answer for the question and returns the next Query, incrementing the current step. If there are no more questions left, this will return null.
URL	getAkitude()	URL to the akitude image.
default String	getQuestion()	Deprecated, for removal: This API element is subject to removal in a future version. use getText() instead.
String	getText()	Returns the question text that should be displayed to the user.
Question	undoAnswer()	This is an interaction method for Question. Goes one question backwards, undoing the previous answer(Answer) call.

Methods inherited from interface org.eu.zajc.akiwrapper.core.entities.Query

getAkiwrapper, getProgression, getStep

Method Details

answer

@Nullable
Query answer(Akiwrapper.Answer answer)

This is an interaction method for Question.
Submits an answer for the question and returns the next Query, incrementing the current step.
If there are no more questions left, this will return null.
Note: A single Question object can only be interacted with once. Calling answer(Answer) or undoAnswer() mutates the session state, so you can only call one of them once.

Parameters:

answer - the Akiwrapper.Answer to submit.

Returns:

the next Query or null if there are none left.

Throws:

IllegalStateException - if this Question is not the same as Akiwrapper.getCurrentQuery(), which happens if you attempt to interact with it twice.

ServerStatusException - if the API server returns an erroneous ObjectInputFilter.Status.

AkinatorException - if something else goes wrong during the API call.

See Also:

• undoAnswer()

undoAnswer

@Nonnull
Question undoAnswer()

This is an interaction method for Question.
Goes one question backwards, undoing the previous answer(Answer) call. For example, if getQuestion() returns a question on step 5, calling this command will return the question on step 4. You can call this as many times as you want, until you reach step 0. Note that this will always return a Question, and never a Guess or null.
Note: A single Question object can only be interacted with once. Calling answer(Answer) or undoAnswer() mutates the session state, so you can only call one of them once.

Returns:

the previous Question.

Throws:

UndoOutOfBoundsException - if the session has exhausted all questions (when getQuestion() returns null.

IllegalStateException - if this Question is not the same as Akiwrapper.getCurrentQuery(), which happens if you attempt to interact with it twice.

ServerStatusException - if the API server returns an erroneous ObjectInputFilter.Status.

AkinatorException - if something else goes wrong during the API call.

See Also:

• answer(Answer)

getText

@Nonnull
String getText()

Returns the question text that should be displayed to the user. This is localized to the Akiwrapper.Language and in line with the Akiwrapper.Theme set in the AkiwrapperBuilder.

Example

Is your character real?

Returns:

the question text.

getQuestion

@Nonnull
@Deprecated(since="2.0",
            forRemoval=true)
default String getQuestion()

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

use getText() instead.

Returns the question text that should be displayed to the user. This is localized to the Akiwrapper.Language and in line with the Akiwrapper.Theme set in the AkiwrapperBuilder.

Example

Is your character real?

Returns:

the question text.

getAkitude

URL getAkitude()

URL to the akitude image. "Akitude" is likely a portmanteau of "Akinator" and "attitude", and they represent Akinator's current confidence - previously this was calculated using a formula on the step and progression values, now it's returned by the API. On the website, the akitude is shown on the left of the question box.

Example

https://en.akinator.com/assets/img/akitudes_670x1096/defi.png

Returns:

the akitude image URL.