org.researchstack.backbone.model

Class Choice<T>

java.lang.Object

org.researchstack.backbone.model.Choice<T>

Type Parameters:

T - the type of value for the choice, usually Integer or String

All Implemented Interfaces:

java.io.Serializable

public class Choice<T>
extends java.lang.Object
implements java.io.Serializable

Choice objects for use in ChoiceAnswerFormat. They typically have an integer or string value, always with a string text representation of the choice for the user.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Choice(java.lang.String text, T value) Creates a choice object with the provided text and value, detailtext is null
Choice(java.lang.String text, T value, java.lang.String detailText) Creates a choice object with the provided text, value, and detailtext

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDetailText() Gets the detail text for this choice, or null
java.lang.String	getText() Return the user-facing text for this choice
T	getValue() Returns the value of type T for this choice
void	setDetailText(java.lang.String detailText) Sets the (optional) detail text for this choice
void	setText(java.lang.String text) Sets the text that the user will see for this choice
void	setValue(T value) Sets the value of type T for this choice

Methods inherited from class java.lang.Object

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

Constructor Detail

Choice

public Choice(java.lang.String text,
              T value)

Creates a choice object with the provided text and value, detailtext is null

Parameters:

text - user-facing text representing the choice

value - value of any type for this choice, type should match other choices in the step

Choice

public Choice(java.lang.String text,
              T value,
              java.lang.String detailText)

Creates a choice object with the provided text, value, and detailtext

Parameters:

text - user-facing text representing the choice

value - value of any type for this choice, type should match other choices in the step

detailText - extra detail text for the choice

Method Detail

getText

public java.lang.String getText()

Return the user-facing text for this choice

Returns:

the text

setText

public void setText(java.lang.String text)

Sets the text that the user will see for this choice

Parameters:

text - the text

getValue

public T getValue()

Returns the value of type T for this choice

Returns:

the value

setValue

public void setValue(T value)

Sets the value of type T for this choice

Parameters:

value - the value of this choice

getDetailText

public java.lang.String getDetailText()

Gets the detail text for this choice, or null

Returns:

the detail text, or null if none

setDetailText

public void setDetailText(java.lang.String detailText)

Sets the (optional) detail text for this choice

Parameters:

detailText - the detail text