Package com.marcpg.libpg.formular

Class FormularResult

java.lang.Object

com.marcpg.libpg.formular.FormularResult

public class FormularResult
extends Object

Represents a fully filled out formular's result with all values. Also provides records for the different question type's answers.
Note that most features will require you to manually implement the JNA dependency (>5.14.0)!

Since:

0.0.8

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	FormularResult.BooleanResult	Represents a result of a BooleanQuestion.
static final record	FormularResult.CheckboxesResult	Represents a result of a CheckboxesQuestion.
static final record	FormularResult.IntegerResult	Represents a result of a IntegerQuestion.
static final record	FormularResult.MultipleChoiceResult	Represents a result of a MultipleChoiceQuestion.
static interface	FormularResult.Result	All results should extend this.
static final record	FormularResult.TextResult	Represents a result of a TextQuestion.

Field Summary

Fields

Modifier and Type	Field	Description
final List<FormularResult.Result>	results	A list of all results of this formular result.

Constructor Summary

Constructors

Constructor	Description
FormularResult(FormularResult.Result... results)	Creates a new formular result with all the results.
FormularResult(List<FormularResult.Result> results)	Creates a new formular result with a list of the results.

Method Summary

Modifier and Type	Method	Description
FormularResult	addResult(FormularResult.Result result)	Adds a result to this formular result.
FormularResult	clearResults()	Clears all results from this formular result.
FormularResult	removeResult(FormularResult.Result result)	Removes a result from this formular result.
Iterator<FormularResult.Result>	toIterator()	Converts the results to an iterator that can be used to go through all of them.

Methods inherited from class java.lang.Object

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

Field Details

results

public final List<FormularResult.Result> results

A list of all results of this formular result.

Constructor Details

FormularResult

public FormularResult(List<FormularResult.Result> results)

Creates a new formular result with a list of the results.

Parameters:

results - The list of all results.

FormularResult

public FormularResult(FormularResult.Result... results)

Creates a new formular result with all the results.

Parameters:

results - All results.

Method Details

addResult

public FormularResult addResult(FormularResult.Result result)

Adds a result to this formular result.

Parameters:

result - The result to add.

Returns:

A reference to this object.

removeResult

public FormularResult removeResult(FormularResult.Result result)

Removes a result from this formular result.

Parameters:

result - The result to remove.

Returns:

A reference to this object.

clearResults

public FormularResult clearResults()

Clears all results from this formular result.

Returns:

A reference to this object.

toIterator

public Iterator<FormularResult.Result> toIterator()

Converts the results to an iterator that can be used to go through all of them.

Returns:

The converted iterator.