ChoiceCallback (Java Platform SE 6)

This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.

Overview

Package

Class

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

javax.security.auth.callback
class ChoiceCallback

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 the handle method of a CallbackHandler to display a list of choices and to retrieve the selected choice(s).

Constructor Summary
`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.

Method Summary
`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(int selection)` Set the selected choice.
`void`	`setSelectedIndexes(int[] selections)` Set the selected choices.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

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.; 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.

Method Detail

allowMultipleSelections

public boolean allowMultipleSelections()

Get the boolean determining whether multiple selections from the choices list are allowed.

Returns:: whether multiple selections are allowed.

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.

getPrompt

public String getPrompt()

Get the prompt.

Returns:: the prompt.

getSelectedIndexes

public int[] getSelectedIndexes()

Get the selected choices.

Returns:: the selected choices, represented as indexes into the choices list.

setSelectedIndex

public void setSelectedIndex(int selection)

Set the selected choice.

Parameters:: selection - the selection represented as an index into the choices list.

setSelectedIndexes

public void setSelectedIndexes(int[] selections)

Set the selected choices.

Parameters:: selections - the selections represented as indexes into the choices list.