javax.security.auth.callback

クラス ChoiceCallback

java.lang.Object

javax.security.auth.callback.ChoiceCallback

すべての実装されたインタフェース:

Serializable、Callback

直系の既知のサブクラス:

RealmChoiceCallback

public class ChoiceCallback
extends Object
implements Callback, Serializable

ベースとなるセキュリティーサービスでは、ChoiceCallback をインスタンス化して CallbackHandler の handle メソッドに渡し、選択肢のリストを表示したり、選択された選択肢を検出したりします。

関連項目:

CallbackHandler、直列化された形式

コンストラクタのサマリー

コンストラクタ

コンストラクタと説明
ChoiceCallback(String prompt, String[] choices, int defaultChoice, boolean multipleSelectionsAllowed) プロンプト、選択肢のリスト、デフォルト選択、および選択リストで複数選択が可能かどうかを表す boolean 値を使用して、ChoiceCallback を構築します。

メソッドのサマリー

メソッド

修飾子と型	メソッドと説明
boolean	allowMultipleSelections() choices リストで複数選択が可能かどうかを意味するブール値を取得します。
String[]	getChoices() 選択肢のリストを取得します。
int	getDefaultChoice() defaultChoice を取得します。
String	getPrompt() プロンプトを取得します。
int[]	getSelectedIndexes() 選択された選択肢を取得します。
void	setSelectedIndex(int selection) 選択された選択肢 (1 つ) を設定します。
void	setSelectedIndexes(int[] selections) 選択された選択肢 (複数) を設定します。

クラス java.lang.Object から継承されたメソッド

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

コンストラクタの詳細

ChoiceCallback

public ChoiceCallback(String prompt,
              String[] choices,
              int defaultChoice,
              boolean multipleSelectionsAllowed)

プロンプト、選択肢のリスト、デフォルト選択、および選択リストで複数選択が可能かどうかを表す boolean 値を使用して、ChoiceCallback を構築します。

パラメータ:

prompt - 選択肢のリストの記述に使用するプロンプト。

choices - 選択肢のリスト。

defaultChoice - 選択肢のリストを表示するときにデフォルトの選択肢として使用される選択肢。この値は choices 配列のインデックスとして表される。

multipleSelectionsAllowed - 選択肢のリストで複数選択が可能かどうかを指定するブール値。

例外:

IllegalArgumentException - prompt が null の場合、prompt の長さが 0 の場合、choices が null の場合、choices の長さが 0 の場合、choices のいずれかの要素が null の場合、choices のいずれかの要素の長さが 0 の場合、または defaultChoice が choices の配列境界内にない場合。

メソッドの詳細

getPrompt

public String getPrompt()

プロンプトを取得します。

戻り値:

プロンプト。

getChoices

public String[] getChoices()

選択肢のリストを取得します。

戻り値:

選択肢のリスト。

getDefaultChoice

public int getDefaultChoice()

defaultChoice を取得します。

戻り値:

choices リストのインデックスとして表される defaultChoice。

allowMultipleSelections

public boolean allowMultipleSelections()

choices リストで複数選択が可能かどうかを意味するブール値を取得します。

戻り値:

複数選択が可能かどうか。

setSelectedIndex

public void setSelectedIndex(int selection)

選択された選択肢 (1 つ) を設定します。

パラメータ:

selection - choices リストのインデックスとして表される選択内容 (1 つ)。

関連項目:

getSelectedIndexes()

setSelectedIndexes

public void setSelectedIndexes(int[] selections)

選択された選択肢 (複数) を設定します。

パラメータ:

selections - choices リストのインデックスとして表される選択内容 (複数)。

例外:

UnsupportedOperationException - 複数選択が許されない場合。複数選択が許されるかどうかは allowMultipleSelections によって決まる。

関連項目:

getSelectedIndexes()

getSelectedIndexes

public int[] getSelectedIndexes()

選択された選択肢を取得します。

戻り値:

choices リストのインデックスとして表される選択された選択肢。

関連項目:

setSelectedIndexes(int[])