Class ChoiceCallback
java.lang.Object
javax.security.auth.callback.ChoiceCallback
- All Implemented Interfaces:
Serializable, Callback
- Direct Known Subclasses:
RealmChoiceCallback
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 Summary
ConstructorsConstructorDescriptionChoiceCallback
(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 multiple selections from the list of choices are allowed. -
Method Summary
Modifier and TypeMethodDescriptionboolean
Get the boolean determining whether multiple selections from thechoices
list are allowed.String[]
Get the list of choices.int
Get the defaultChoice.Get the prompt.int[]
Get the selected choices.void
setSelectedIndex
(int selection) Set the selected choice.void
setSelectedIndexes
(int[] selections) Set the selected choices.Methods declared in class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Modifier and TypeMethodDescriptionprotected Object
clone()
Creates and returns a copy of this object.boolean
Indicates whether some other object is "equal to" this one.protected void
finalize()
Deprecated, for removal: This API element is subject to removal in a future version.Finalization is deprecated and subject to removal in a future release.final Class
<?> getClass()
Returns the runtime class of thisObject
.int
hashCode()
Returns a hash code value for this object.final void
notify()
Wakes up a single thread that is waiting on this object's monitor.final void
Wakes up all threads that are waiting on this object's monitor.toString()
Returns a string representation of the object.final void
wait()
Causes the current thread to wait until it is awakened, typically by being notified or interrupted.final void
wait
(long timeoutMillis) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.final void
wait
(long timeoutMillis, int nanos) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
-
Constructor Details
-
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 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 thechoices
array.multipleSelectionsAllowed
- boolean specifying whether 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 Details
-
getPrompt
-
getChoices
-
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:
-
setSelectedIndexes
public void setSelectedIndexes(int[] selections) Set the selected choices.- Parameters:
selections
- the selections represented as indexes into thechoices
list. The array is cloned to protect against subsequent modification.- Throws:
UnsupportedOperationException
- if multiple selections are not allowed, as determined byallowMultipleSelections
.- See Also:
-
getSelectedIndexes
public int[] getSelectedIndexes()Get the selected choices.- Returns:
- a copy of the selected choices, represented as indexes into the
choices
list. - See Also:
-