Package Summary  Overview Summary

class:ChoiceCallback [NONE]
All Implemented Interfaces:
Serializable, Callback
Direct Known Subclasses:
RealmChoiceCallback
public class ChoiceCallbackextends 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).

Since:
1.4
See Also:

constructor:ChoiceCallback(java.lang.String,java.lang.String[],int,boolean) [CHANGED]

  • ChoiceCallback

    public ChoiceCallback (String prompt, String[] choices, int defaultChoice, boolean multipleSelectionsAllowed)
    Construct a ChoiceCallback with a prompt, a list of choices, a default choice, and a boolean specifying whether or notmultiple selections from the list of choices are allowed.
    Parameters:
    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 or notmultiple selections can be made from the list of choices.
    Throws:
    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.

  • ChoiceCallback

    public ChoiceCallback (String prompt, String[] choices, int defaultChoice, boolean multipleSelectionsAllowed)
    Construct a ChoiceCallback 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. 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 or not multiple selections can be made from the list of choices.
    Throws:
    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.

  • ChoiceCallback

    public ChoiceCallback (String prompt, String[] choices, int defaultChoice, boolean multipleSelectionsAllowed)
    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.
    Parameters:
    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.
    Throws:
    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.

method:getPrompt() [NONE]

  • getPrompt

    public String getPrompt()
    Get the prompt.
    Returns:
    the prompt.

    • method:getChoices() [NONE]

    getChoices

    public String[] getChoices()
    Get the list of choices.
    Returns:
    a copy of the list of choices.

    method:getDefaultChoice() [NONE]

    getDefaultChoice

    public int getDefaultChoice()
    Get the defaultChoice.
    Returns:
    the defaultChoice, represented as an index into the choices list.

    method:allowMultipleSelections() [NONE]

    allowMultipleSelections

    public boolean allowMultipleSelections()
    Get the boolean determining whether multiple selections from the choices list are allowed.
    Returns:
    whether multiple selections are allowed.

    method:setSelectedIndex(int) [NONE]

    setSelectedIndex

    public void setSelectedIndex (int selection)
    Set the selected choice.
    Parameters:
    selection - the selection represented as an index into the choices list.
    See Also:

    method:setSelectedIndexes(int[]) [NONE]

    setSelectedIndexes

    public void setSelectedIndexes (int[] selections)
    Set the selected choices.
    Parameters:
    selections - the selections represented as indexes into the choices list. The array is cloned to protect against subsequent modification.
    Throws:
    UnsupportedOperationException - if multiple selections are not allowed, as determined by allowMultipleSelections.
    See Also:

    method:getSelectedIndexes() [NONE]

    getSelectedIndexes

    public int[] getSelectedIndexes()
    Get the selected choices.
    Returns:
    a copy of the selected choices, represented as indexes into the choices list.
    See Also:

    © 2023 Oracle Corporation and/or its affiliates