- 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
ChoiceCallback
to thehandle
method of aCallbackHandler
to display a list of choices and to retrieve the selected choice(s).- See Also:
CallbackHandler
, Serialized Form
-
-
Constructor Summary
Constructors Constructor and Description ChoiceCallback(String prompt, String[] choices, int defaultChoice, boolean multipleSelectionsAllowed)
Construct aChoiceCallback
with 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
Methods Modifier and Type Method and Description boolean
allowMultipleSelections()
Get the boolean determining whether multiple selections from thechoices
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(int selection)
Set the selected choice.void
setSelectedIndexes(int[] selections)
Set the selected choices.
-
-
-
Constructor Detail
-
ChoiceCallback
public ChoiceCallback(String prompt, String[] choices, int defaultChoice, boolean multipleSelectionsAllowed)
Construct aChoiceCallback
with 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 thechoices
array.multipleSelectionsAllowed
- boolean specifying whether or not multiple selections can be made from the list of choices.- Throws:
IllegalArgumentException
- ifprompt
is null, ifprompt
has a length of 0, ifchoices
is null, ifchoices
has a length of 0, if any element fromchoices
is null, if any element fromchoices
has a length of 0 or ifdefaultChoice
does 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
choices
list.
-
allowMultipleSelections
public boolean allowMultipleSelections()
Get the boolean determining whether multiple selections from thechoices
list 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 thechoices
list.- See Also:
getSelectedIndexes()
-
setSelectedIndexes
public void setSelectedIndexes(int[] selections)
Set the selected choices.- Parameters:
selections
- the selections represented as indexes into thechoices
list.- 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
choices
list. - See Also:
setSelectedIndexes(int[])
-
-
Nederlandse vertaling
U hebt gevraagd om deze site in het Nederlands te bezoeken. Voor nu wordt alleen de interface vertaald, maar nog niet alle inhoud.Als je me wilt helpen met vertalingen, is je bijdrage welkom. Het enige dat u hoeft te doen, is u op de site registreren en mij een bericht sturen waarin u wordt gevraagd om u toe te voegen aan de groep vertalers, zodat u de gewenste pagina's kunt vertalen. Een link onderaan elke vertaalde pagina geeft aan dat u de vertaler bent en heeft een link naar uw profiel.
Bij voorbaat dank.
Document heeft de 11/06/2005 gemaakt, de laatste keer de 04/03/2020 gewijzigd
Bron van het afgedrukte document:https://www.gaudry.be/nl/java-api-rf-javax/security/auth/callback/ChoiceCallback.html
De infobrol is een persoonlijke site waarvan de inhoud uitsluitend mijn verantwoordelijkheid is. De tekst is beschikbaar onder CreativeCommons-licentie (BY-NC-SA). Meer info op de gebruiksvoorwaarden en de auteur.
Referenties
Deze verwijzingen en links verwijzen naar documenten die geraadpleegd zijn tijdens het schrijven van deze pagina, of die aanvullende informatie kunnen geven, maar de auteurs van deze bronnen kunnen niet verantwoordelijk worden gehouden voor de inhoud van deze pagina.
De auteur Deze site is als enige verantwoordelijk voor de manier waarop de verschillende concepten, en de vrijheden die met de referentiewerken worden genomen, hier worden gepresenteerd. Vergeet niet dat u meerdere broninformatie moet doorgeven om het risico op fouten te verkleinen.