Package com.sun.interview
Class ChoiceQuestion
java.lang.Object
com.sun.interview.Question
com.sun.interview.ChoiceQuestion
- Direct Known Subclasses:
TestsInterview.TreeOrFileChoiceQuestion
,YesNoQuestion
A
question
to which the response is one of a number of choices.-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected String
The current (default or latest) response to this question. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
ChoiceQuestion
(Interview interview, String tag) Create a question with a nominated tag.protected
ChoiceQuestion
(Interview interview, String tag, String... choices) Create a question with a nominated tag. -
Method Summary
Modifier and TypeMethodDescriptionvoid
clear()
Clear any response to this question, resetting the value back to its initial state.String[]
Get the set of legal responses for this question.Get the default response for this question.String[]
Get the display values for the set of legal responses for this question.Get the display string for the current (default or latest) response to this question.Get the response to this question as a string.getValue()
Get the internal value for the current (default or latest) response to this question.Verify this question is on the current path, and if it is, return the current value.boolean
Check if the question always has a valid response.boolean
Check if the question currently has a valid response.protected void
Save the value for this question in a dictionary, using the tag as the key.protected void
setChoices
(String... choices) Set the set of legal responses for this question.protected void
setChoices
(String[] choices, boolean localize) Set the set of legal responses for this question.protected void
setChoices
(String[] choices, String... displayChoices) Set the set of legal responses for this question.void
Set the default response for this question, used by the clear method.protected void
setI18NChoices
(String... choices) Deprecated.Use the other setChoices() methods, which support i18n as an option.void
Set the current value.Methods inherited from class com.sun.interview.Question
addMarker, equals, export, getChecklistItems, getHelpID, getImage, getInterview, getKey, getNext, getResourceString, getResourceString, getSummary, getTag, getText, getTextArgs, hashCode, hasMarker, isEnabled, isHidden, load, reload, removeMarker, setHelpID, setImage, setImage, setSummary, setText
-
Field Details
-
value
The current (default or latest) response to this question.
-
-
Constructor Details
-
ChoiceQuestion
Create a question with a nominated tag. If this constructor is used, the choices must be supplied separately.- Parameters:
interview
- The interview containing this question.tag
- A unique tag to identify this specific question.
-
ChoiceQuestion
Create a question with a nominated tag.- Parameters:
interview
- The interview containing this question.tag
- A unique tag to identify this specific question.choices
- The set of legal values for responses to this question.
-
-
Method Details
-
setChoices
Set the set of legal responses for this question. If the current value is one of the choices (string equality), it will be set identically equal to that choice; otherwise, the current value will be set to the first choice.- Parameters:
choices
- An array of strings identifying the set of legal responses for this question. Depending on the value of the 'localize' argument, the strings will be used literally, or will be used to construct keys to look up resources in the containing interview's resource bundle, in order to get the display strings. In both cases, the current value will always be one of the values in the choices array.localize
- if false, the choices will be used directly as the display choices; otherwise the choices will be used to construct keys to get localized values from the interview's resource bundle.- Throws:
NullPointerException
- if choices is null.- See Also:
-
setChoices
Set the set of legal responses for this question. If the current value is one of the choices (string equality), it will be set identically equal to that choice; otherwise, the current value will be set to the first choice.- Parameters:
choices
- An array of strings identifying the set of legal responses for this question.displayChoices
- An array of strings to be presented to the user that identify the legal responses to this question. The value can also be null, to indicate that the display choices should be determined automatically by obtaining localized values for the entries in the choices array.- Throws:
NullPointerException
- if choices is null.IllegalArgumentException
- if displayChoices is not null and is a different length than choices.- See Also:
-
setI18NChoices
Deprecated.Use the other setChoices() methods, which support i18n as an option.Set the set of legal responses for this question, using the standard resource bundle for localization.- Parameters:
choices
- The set of possible responses for this question. Each entry in the argument array is localized by looking up question-key.choices[i] in the standard resource bundle used by the parent interview. If an appropriate entry is not found, the array value (choices[i]) is used instead.- See Also:
-
getChoices
Get the set of legal responses for this question.- Returns:
- The set of possible responses for this question.
- See Also:
-
setChoices
Set the set of legal responses for this question. If the current value is one of the choices (string equality), it will be set identically equal to that choice; otherwise, the current value will be set to the first choice.- Parameters:
choices
- The set of possible responses for this question.- Throws:
NullPointerException
- if choices is null.- See Also:
-
getDisplayChoices
Get the display values for the set of legal responses for this question. The display values will typically be different from the standard values if they have been localized.- Returns:
- The display values for the set of possible responses for this question.
- See Also:
-
getDefaultValue
Get the default response for this question. It defaults to the first choice in the array of choices set with setChoices.- Returns:
- the default response for this question.
- See Also:
-
setDefaultValue
Set the default response for this question, used by the clear method.- Parameters:
v
- the default response for this question.- See Also:
-
getValue
Get the internal value for the current (default or latest) response to this question.- Returns:
- The current value.
- See Also:
-
setValue
Set the current value. -
getDisplayValue
Get the display string for the current (default or latest) response to this question.- Returns:
- The display string for the current value.
- See Also:
-
getValueOnPath
Verify this question is on the current path, and if it is, return the current value.- Returns:
- the current value of this question
- Throws:
Interview.NotOnPathFault
- if this question is not on the current path- See Also:
-
getStringValue
Description copied from class:Question
Get the response to this question as a string.- Specified by:
getStringValue
in classQuestion
- Returns:
- a string representing the current response to this question, or null.
- See Also:
-
isValueValid
public boolean isValueValid()Description copied from class:Question
Check if the question currently has a valid response.- Specified by:
isValueValid
in classQuestion
- Returns:
- true if the question currently has a valid response, and false otherwise.
-
isValueAlwaysValid
public boolean isValueAlwaysValid()Description copied from class:Question
Check if the question always has a valid response. This may be true, for example, for a choice question with a default response.- Specified by:
isValueAlwaysValid
in classQuestion
- Returns:
- true if the question always has a valid response, and false otherwise.
-
clear
public void clear()Clear any response to this question, resetting the value back to its initial state. -
save
Save the value for this question in a dictionary, using the tag as the key.
-