Serializable
, Callback
RealmChoiceCallback
public class ChoiceCallback extends Object implements Callback, Serializable
Underlying security services instantiate and pass a ChoiceCallback
to the handle
method of a CallbackHandler
to display a list of choices and to retrieve the selected choice(s).
Constructor | Description |
---|---|
ChoiceCallback |
Construct a ChoiceCallback with a prompt, a list of choices, a default choice, and a boolean specifying whether multiple selections from the list of choices are allowed. |
Modifier and Type | Method | Description |
---|---|---|
boolean |
allowMultipleSelections() |
Get the boolean determining whether multiple selections from the choices list are allowed. |
String[] |
getChoices() |
Get the list of choices. |
int |
getDefaultChoice() |
Get the defaultChoice. |
String |
getPrompt() |
Get the prompt. |
int[] |
getSelectedIndexes() |
Get the selected choices. |
void |
setSelectedIndex |
Set the selected choice. |
void |
setSelectedIndexes |
Set the selected choices. |
public ChoiceCallback(String prompt, String[] choices, int defaultChoice, boolean multipleSelectionsAllowed)
ChoiceCallback
with a prompt, a list of choices, a default choice, and a boolean specifying whether multiple selections from the list of choices are allowed.prompt
- the prompt used to describe the list of choices.choices
- the list of choices. The array is cloned to protect against subsequent modification.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 the choices
array.multipleSelectionsAllowed
- boolean specifying whether multiple selections can be made from the list of choices.IllegalArgumentException
- if prompt
is null, if prompt
has a length of 0, if choices
is null, if choices
has a length of 0, if any element from choices
is null, if any element from choices
has a length of 0 or if defaultChoice
does not fall within the array boundaries of choices
.public String getPrompt()
public String[] getChoices()
public int getDefaultChoice()
choices
list.public boolean allowMultipleSelections()
choices
list are allowed.public void setSelectedIndex(int selection)
selection
- the selection represented as an index into the choices
list.public void setSelectedIndexes(int[] selections)
selections
- the selections represented as indexes into the choices
list. The array is cloned to protect against subsequent modification.UnsupportedOperationException
- if multiple selections are not allowed, as determined by allowMultipleSelections
.public int[] getSelectedIndexes()
choices
list.
© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/java.base/javax/security/auth/callback/ChoiceCallback.html