- java.lang.Object
-
- javax.security.auth.callback.ChoiceCallback
-
- All Implemented Interfaces:
Serializable,Callback
- Direct Known Subclasses:
RealmChoiceCallback
public class ChoiceCallback extends Object implements Callback, Serializable
Underlying security services instantiate and pass a
ChoiceCallbackto thehandlemethod of aCallbackHandlerto display a list of choices and to retrieve the selected choice(s).- Since:
- 1.4
- See Also:
CallbackHandler, Serialized Form
-
-
Constructor Summary
Constructors Constructor Description ChoiceCallback(String prompt, String[] choices, int defaultChoice, boolean multipleSelectionsAllowed)Construct aChoiceCallbackwith a prompt, a list of choices, a default choice, and a boolean specifying whether or not multiple selections from the list of choices are allowed.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description booleanallowMultipleSelections()Get the boolean determining whether multiple selections from thechoiceslist are allowed.String[]getChoices()Get the list of choices.intgetDefaultChoice()Get the defaultChoice.StringgetPrompt()Get the prompt.int[]getSelectedIndexes()Get the selected choices.voidsetSelectedIndex(int selection)Set the selected choice.voidsetSelectedIndexes(int[] selections)Set the selected choices.
-
-
-
Constructor Detail
-
ChoiceCallback
public ChoiceCallback(String prompt, String[] choices, int defaultChoice, boolean multipleSelectionsAllowed)
Construct aChoiceCallbackwith a prompt, a list of choices, a default choice, and a boolean specifying whether or not multiple selections from the list of choices are allowed.- Parameters:
prompt- the prompt used to describe the list of choices.choices- the list of choices.defaultChoice- the choice to be used as the default choice when the list of choices are displayed. This value is represented as an index into thechoicesarray.multipleSelectionsAllowed- boolean specifying whether or not multiple selections can be made from the list of choices.- Throws:
IllegalArgumentException- ifpromptis null, ifprompthas a length of 0, ifchoicesis null, ifchoiceshas a length of 0, if any element fromchoicesis null, if any element fromchoiceshas a length of 0 or ifdefaultChoicedoes not fall within the array boundaries ofchoices.
-
-
Method Detail
-
getPrompt
public String getPrompt()
Get the prompt.- Returns:
- the prompt.
-
getChoices
public String[] getChoices()
Get the list of choices.- Returns:
- the list of choices.
-
getDefaultChoice
public int getDefaultChoice()
Get the defaultChoice.- Returns:
- the defaultChoice, represented as an index into
the
choiceslist.
-
allowMultipleSelections
public boolean allowMultipleSelections()
Get the boolean determining whether multiple selections from thechoiceslist are allowed.- Returns:
- whether multiple selections are allowed.
-
setSelectedIndex
public void setSelectedIndex(int selection)
Set the selected choice.- Parameters:
selection- the selection represented as an index into thechoiceslist.- See Also:
getSelectedIndexes()
-
setSelectedIndexes
public void setSelectedIndexes(int[] selections)
Set the selected choices.- Parameters:
selections- the selections represented as indexes into thechoiceslist.- Throws:
UnsupportedOperationException- if multiple selections are not allowed, as determined byallowMultipleSelections.- See Also:
getSelectedIndexes()
-
getSelectedIndexes
public int[] getSelectedIndexes()
Get the selected choices.- Returns:
- the selected choices, represented as indexes into the
choiceslist. - See Also:
setSelectedIndexes(int[])
-
-