Package io.dialob.api.questionnaire
Class ImmutableQuestionnaire.Builder
java.lang.Object
io.dialob.api.questionnaire.ImmutableQuestionnaire.Builder
- Enclosing class:
- ImmutableQuestionnaire
Builds instances of type
ImmutableQuestionnaire.
Initialize attributes and then invoke the build() method to create an
immutable instance.
Builder is not thread-safe and generally should not be stored in a field or collection,
but instead used immediately to create instances.
-
Method Summary
Modifier and TypeMethodDescriptionactiveItem(String activeItem) Initializes the value for theactiveItemattribute.addAllAnswers(Iterable<? extends Answer> elements) Adds elements toanswerslist.addAllContext(Iterable<? extends ContextValue> elements) Adds elements tocontextlist.addAllErrors(Iterable<? extends Error> elements) Adds elements toerrorslist.addAllValueSets(Iterable<? extends ValueSet> elements) Adds elements tovalueSetslist.addAllVariableValues(Iterable<? extends VariableValue> elements) Adds elements tovariableValueslist.addAnswers(Answer element) Adds one element toanswerslist.addAnswers(Answer... elements) Adds elements toanswerslist.addAnswers(String id, Object value) Constructs and adds an element for theanswerslist.addContext(ContextValue element) Adds one element tocontextlist.addContext(ContextValue... elements) Adds elements tocontextlist.addContext(String id, Object value) Constructs and adds an element for thecontextlist.Adds one element toerrorslist.Adds elements toerrorslist.Constructs and adds an element for theerrorslist.addValueSets(ValueSet element) Adds one element tovalueSetslist.addValueSets(ValueSet... elements) Adds elements tovalueSetslist.addVariableValues(VariableValue element) Adds one element tovariableValueslist.addVariableValues(VariableValue... elements) Adds elements tovariableValueslist.addVariableValues(String id, Object value) Constructs and adds an element for thevariableValueslist.Sets or replaces all elements foranswerslist.build()Builds a newImmutableQuestionnaire.context(Iterable<? extends ContextValue> elements) Sets or replaces all elements forcontextlist.Sets or replaces all elements forerrorslist.from(ModifiableQuestionnaire instance) Fill a builder with attribute values from the providedModifiableQuestionnaireinstance.from(Questionnaire instance) Fill a builder with attribute values from the providedQuestionnaireinstance.Initializes the value for theidattribute.metadata(Questionnaire.Metadata metadata) Initializes the value for themetadataattribute.Initializes the value for therevattribute.Sets or replaces all elements forvalueSetslist.variableValues(Iterable<? extends VariableValue> elements) Sets or replaces all elements forvariableValueslist.
-
Method Details
-
from
Fill a builder with attribute values from the providedModifiableQuestionnaireinstance.- Parameters:
instance- The instance from which to copy values- Returns:
thisbuilder for use in a chained invocation
-
from
Fill a builder with attribute values from the providedQuestionnaireinstance. Regular attribute values will be replaced with those from the given instance. Absent optional values will not replace present values. Collection elements and entries will be added, not replaced.- Parameters:
instance- The instance from which to copy values- Returns:
thisbuilder for use in a chained invocation
-
id
Initializes the value for theidattribute.- Parameters:
id- The value for id (can benull)- Returns:
thisbuilder for use in a chained invocation
-
rev
Initializes the value for therevattribute.- Parameters:
rev- The value for rev (can benull)- Returns:
thisbuilder for use in a chained invocation
-
addAnswers
Adds one element toanswerslist.- Parameters:
element- A answers element- Returns:
thisbuilder for use in a chained invocation
-
addAnswers
Constructs and adds an element for theanswerslist.- Parameters:
id- The value foranswers.id(can benull)value- The value foranswers.value(can benull)- Returns:
thisbuilder for use in a chained invocation
-
addAnswers
Adds elements toanswerslist.- Parameters:
elements- An array of answers elements- Returns:
thisbuilder for use in a chained invocation
-
answers
Sets or replaces all elements foranswerslist.- Parameters:
elements- An iterable of answers elements- Returns:
thisbuilder for use in a chained invocation
-
addAllAnswers
Adds elements toanswerslist.- Parameters:
elements- An iterable of answers elements- Returns:
thisbuilder for use in a chained invocation
-
addContext
Adds one element tocontextlist.- Parameters:
element- A context element- Returns:
thisbuilder for use in a chained invocation
-
addContext
Constructs and adds an element for thecontextlist.- Parameters:
id- The value forcontext.id(can benull)value- The value forcontext.value(can benull)- Returns:
thisbuilder for use in a chained invocation
-
addContext
Adds elements tocontextlist.- Parameters:
elements- An array of context elements- Returns:
thisbuilder for use in a chained invocation
-
context
Sets or replaces all elements forcontextlist.- Parameters:
elements- An iterable of context elements- Returns:
thisbuilder for use in a chained invocation
-
addAllContext
public final ImmutableQuestionnaire.Builder addAllContext(Iterable<? extends ContextValue> elements) Adds elements tocontextlist.- Parameters:
elements- An iterable of context elements- Returns:
thisbuilder for use in a chained invocation
-
activeItem
Initializes the value for theactiveItemattribute.- Parameters:
activeItem- The value for activeItem (can benull)- Returns:
thisbuilder for use in a chained invocation
-
addErrors
Adds one element toerrorslist.- Parameters:
element- A errors element- Returns:
thisbuilder for use in a chained invocation
-
addErrors
Constructs and adds an element for theerrorslist.- Parameters:
id- The value forerrors.idcode- The value forerrors.code(can benull)description- The value forerrors.description(can benull)- Returns:
thisbuilder for use in a chained invocation
-
addErrors
Adds elements toerrorslist.- Parameters:
elements- An array of errors elements- Returns:
thisbuilder for use in a chained invocation
-
errors
Sets or replaces all elements forerrorslist.- Parameters:
elements- An iterable of errors elements- Returns:
thisbuilder for use in a chained invocation
-
addAllErrors
Adds elements toerrorslist.- Parameters:
elements- An iterable of errors elements- Returns:
thisbuilder for use in a chained invocation
-
addVariableValues
Adds one element tovariableValueslist.- Parameters:
element- A variableValues element- Returns:
thisbuilder for use in a chained invocation
-
addVariableValues
Constructs and adds an element for thevariableValueslist.- Parameters:
id- The value forvariableValues.idvalue- The value forvariableValues.value(can benull)- Returns:
thisbuilder for use in a chained invocation
-
addVariableValues
Adds elements tovariableValueslist.- Parameters:
elements- An array of variableValues elements- Returns:
thisbuilder for use in a chained invocation
-
variableValues
public final ImmutableQuestionnaire.Builder variableValues(Iterable<? extends VariableValue> elements) Sets or replaces all elements forvariableValueslist.- Parameters:
elements- An iterable of variableValues elements- Returns:
thisbuilder for use in a chained invocation
-
addAllVariableValues
public final ImmutableQuestionnaire.Builder addAllVariableValues(Iterable<? extends VariableValue> elements) Adds elements tovariableValueslist.- Parameters:
elements- An iterable of variableValues elements- Returns:
thisbuilder for use in a chained invocation
-
addValueSets
Adds one element tovalueSetslist.- Parameters:
element- A valueSets element- Returns:
thisbuilder for use in a chained invocation
-
addValueSets
Adds elements tovalueSetslist.- Parameters:
elements- An array of valueSets elements- Returns:
thisbuilder for use in a chained invocation
-
valueSets
Sets or replaces all elements forvalueSetslist.- Parameters:
elements- An iterable of valueSets elements- Returns:
thisbuilder for use in a chained invocation
-
addAllValueSets
Adds elements tovalueSetslist.- Parameters:
elements- An iterable of valueSets elements- Returns:
thisbuilder for use in a chained invocation
-
metadata
Initializes the value for themetadataattribute.- Parameters:
metadata- The value for metadata (can benull)- Returns:
thisbuilder for use in a chained invocation
-
build
Builds a newImmutableQuestionnaire.- Returns:
- An immutable instance of Questionnaire
- Throws:
IllegalStateException- if any required attributes are missing
-