Package com.marcpg.libpg.formular.question

Class BooleanQuestion

java.lang.Object
com.marcpg.libpg.formular.question.Question
com.marcpg.libpg.formular.question.BooleanQuestion
public class BooleanQuestion extends Question
A question with either true or false, with advanced input supporting multiple languages, based on starting letters.
Note that most features will require you to manually implement the JNA dependency (>5.14.0)!
Since:
0.0.8
See Also:

  • Field Details

    • FALSE_LETTERS

      public static final List<Character> FALSE_LETTERS
      All starting letters that correspond to a negative answer.

    • TRUE_LETTERS

      public static final List<Character> TRUE_LETTERS
      All starting letters that correspond to a positive answer.

  • Constructor Details

    • BooleanQuestion

      public BooleanQuestion(@Pattern("[a-z0-9_-]+") String id, String title, String description, boolean defaultChoice)
      Creates a new boolean question.
      Parameters:
      id - The question's unique identifier.
      title - The question's title.
      description - The question's description.
      defaultChoice - The question's default choice.

    • BooleanQuestion

      public BooleanQuestion(@Pattern("[a-z0-9_-]+") String id, String title, String description)
      Creates a new boolean question with the default choice set to true.
      Parameters:
      id - The question's unique identifier.
      title - The question's title.
      description - The question's description.

  • Method Details

    • getDefaultChoice

      public boolean getDefaultChoice()
      Gets the set default choice. By default, this is true.
      Returns:
      The question's default choice.

    • resetState

      public void resetState()
      Description copied from class: Question
      Resets the state of this question to be as if it was just created. Won't reset the question's settings, but only the already chosen and rendered things.
      Specified by:
      resetState in class Question

    • setChoice

      public void setChoice(boolean choice)
      Sets the choice, if the question wasn't already submitted.
      Parameters:
      choice - The new choice.

    • submit

      public void submit(boolean choice)
      Submits the question with a specific value.
      Parameters:
      choice - The choice to be submitted.

    • submit

      public void submit()
      Description copied from class: Question
      Submits the question with the current choice and locks in a final answer.
      Specified by:
      submit in class Question

    • getInput

      public Boolean getInput()
      Description copied from class: Question
      Gets the current or preferably final input of the question.
      Specified by:
      getInput in class Question
      Returns:
      The current or preferably final input of this question.

    • toResult

      public FormularResult.Result toResult()
      Description copied from class: Question
      Converts this question to a Result, that can be used in a FormularResult.
      Specified by:
      toResult in class Question
      Returns:
      The converted result.

    • cliRender

      public void cliRender()
      Renders the current question to System.out. Will only work for CLIFormulars.
      If the default choice is true, it will ask this: Choice [Y|n]:
      Specified by:
      cliRender in class Question