OpenJDK 1.22 · javax.security.auth.callback.ChoiceCallback

Modifier and Type	Field and Description
private String[]	choices
private final int	defaultChoice
private final boolean	multipleSelectionsAllowed
private final String	prompt
private int[]	selections
private static final long	serialVersionUID

Constructor Summary

Access Constructor and Description

Access	Constructor and Description
public	ChoiceCallback(String the prompt used to describe the list of choices. prompt, String[] the list of choices. The array is cloned to protect against subsequent modification. choices, int 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. defaultChoice, boolean boolean specifying whether multiple selections can be made from the list of choices. 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.

public

the prompt used to describe the list of choices.

prompt, String[]

the list of choices. The array is cloned to protect against subsequent modification.

choices, int

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.

defaultChoice, boolean

boolean specifying whether multiple selections can be made from the list of choices.

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.

Method Summary

Modifier and Type	Method and Description
public boolean	Returns: whether multiple selections are allowed. allowMultipleSelections() Get the boolean determining whether multiple selections from the `choices` list are allowed.
public String[]	Returns: a copy of the list of choices. getChoices() Get the list of choices.
public int	Returns: the defaultChoice, represented as an index into the `choices` list. getDefaultChoice() Get the defaultChoice.
public String	Returns: the prompt. getPrompt() Get the prompt.
public int[]	Returns: a copy of the selected choices, represented as indexes into the `choices` list. getSelectedIndexes() Get the selected choices.
private void	readObject(ObjectInputStream the `ObjectInputStream` from which data is read stream) Restores the state of this object from the stream.
public void	setSelectedIndex(int the selection represented as an index into the `choices` list. selection) Set the selected choice.
public void	setSelectedIndexes(int[] the selections represented as indexes into the `choices` list. The array is cloned to protect against subsequent modification. selections) Set the selected choices.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

choices	back to summary
private String[] choices Since 1.4

defaultChoice	back to summary
private final int defaultChoice Since 1.4

multipleSelectionsAllowed	back to summary
private final boolean multipleSelectionsAllowed Since 1.4

prompt	back to summary
private final String prompt Since 1.4

selections	back to summary
private int[] selections Since 1.4

serialVersionUID	back to summary
private static final long serialVersionUID Annotations @Serial

Constructor Detail

ChoiceCallback back to summary

ChoiceCallback	back to summary
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:String the prompt used to describe the list of choices. choices:String[] the list of choices. The array is cloned to protect against subsequent modification. defaultChoice:int 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 boolean specifying whether multiple selections can be made from the list of choices. Exceptions 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 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:String: the prompt used to describe the list of choices.
choices:String[]: the list of choices. The array is cloned to protect against subsequent modification.
defaultChoice:int: 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: boolean specifying whether multiple selections can be made from the list of choices.

Exceptions

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 Detail

allowMultipleSelections back to summary

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

public boolean allowMultipleSelections()

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

Returns:boolean: whether multiple selections are allowed.

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

getChoices

back to summary

public String[] getChoices()

Get the list of choices.

Returns:String[]: a copy of the list of choices.

getDefaultChoice back to summary

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

public int getDefaultChoice()

Get the defaultChoice.

Returns:int: the defaultChoice, represented as an index into the choices list.

getPrompt	back to summary
public String getPrompt() Get the prompt. Returns:String the prompt.

getPrompt

back to summary

public String getPrompt()

Get the prompt.

Returns:String: the prompt.

getSelectedIndexes back to summary

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

public int[] getSelectedIndexes()

Get the selected choices.

Returns:int[]: a copy of the selected choices, represented as indexes into the choices list.
See Also: setSelectedIndexes

readObject back to summary

readObject	back to summary
private void readObject(ObjectInputStream stream) throws IOException, ClassNotFoundException Restores the state of this object from the stream. Parameters stream:ObjectInputStream the `ObjectInputStream` from which data is read Annotations @Serial Exceptions IOException: if an I/O error occurs ClassNotFoundException: if a serialized class cannot be loaded

private void readObject(ObjectInputStream stream) throws IOException, ClassNotFoundException

Restores the state of this object from the stream.

Parameters

stream:ObjectInputStream: the ObjectInputStream from which data is read

Annotations

@Serial

Exceptions

IOException:: if an I/O error occurs
ClassNotFoundException:: if a serialized class cannot be loaded

setSelectedIndex back to summary

setSelectedIndex	back to summary
public void setSelectedIndex(int selection) Set the selected choice. Parameters selection:int the selection represented as an index into the `choices` list. See Also `getSelectedIndexes`

public void setSelectedIndex(int selection)

Set the selected choice.

Parameters

selection:int: the selection represented as an index into the choices list.

See Also

getSelectedIndexes

setSelectedIndexes back to summary

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

public void setSelectedIndexes(int[] selections)

Set the selected choices.

Parameters

selections:int[]: the selections represented as indexes into the choices list. The array is cloned to protect against subsequent modification.

Exceptions

UnsupportedOperationException:: if multiple selections are not allowed, as determined by allowMultipleSelections.

See Also

getSelectedIndexes

public Class ChoiceCallback

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail