/* * @(#)ChoiceCallback.java 1.17 03/12/19 * * Copyright 2004 Sun Microsystems, Inc. All rights reserved. * SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms. */ package javax.security.auth.callback; /** *

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). * * @version 1.17, 12/19/03 * @see javax.security.auth.callback.CallbackHandler */ public class ChoiceCallback implements Callback, java.io.Serializable { private static final long serialVersionUID = -3975664071579892167L; /** * @serial * @since 1.4 */ private String prompt; /** * @serial the list of choices * @since 1.4 */ private String[] choices; /** * @serial the choice to be used as the default choice * @since 1.4 */ private int defaultChoice; /** * @serial whether multiple selections are allowed from the list of * choices * @since 1.4 */ private boolean multipleSelectionsAllowed; /** * @serial the selected choices, represented as indexes into the * choices list. * @since 1.4 */ private int[] selections; /** * 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. * *

* * @param prompt the prompt used to describe the list of choices.

* * @param choices the list of choices.

* * @param 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.

* * @param multipleSelectionsAllowed boolean specifying whether or * not multiple selections can be made from the * list of choices. * * @exception 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) { if (prompt == null || prompt.length() == 0 || choices == null || choices.length == 0 || defaultChoice < 0 || defaultChoice >= choices.length) throw new IllegalArgumentException(); for (int i = 0; i < choices.length; i++) { if (choices[i] == null || choices[i].length() == 0) throw new IllegalArgumentException(); } this.prompt = prompt; this.choices = choices; this.defaultChoice = defaultChoice; this.multipleSelectionsAllowed = multipleSelectionsAllowed; } /** * Get the prompt. * *

* * @return the prompt. */ public String getPrompt() { return prompt; } /** * Get the list of choices. * *

* * @return the list of choices. */ public String[] getChoices() { return choices; } /** * Get the defaultChoice. * *

* * @return the defaultChoice, represented as an index into * the choices list. */ public int getDefaultChoice() { return defaultChoice; } /** * Get the boolean determining whether multiple selections from * the choices list are allowed. * *

* * @return whether multiple selections are allowed. */ public boolean allowMultipleSelections() { return multipleSelectionsAllowed; } /** * Set the selected choice. * *

* * @param selection the selection represented as an index into the * choices list. * * @see #getSelectedIndexes */ public void setSelectedIndex(int selection) { this.selections = new int[1]; this.selections[0] = selection; } /** * Set the selected choices. * *

* * @param selections the selections represented as indexes into the * choices list. * * @exception UnsupportedOperationException if multiple selections are * not allowed, as determined by * allowMultipleSelections. * * @see #getSelectedIndexes */ public void setSelectedIndexes(int[] selections) { if (!multipleSelectionsAllowed) throw new UnsupportedOperationException(); this.selections = selections; } /** * Get the selected choices. * *

* * @return the selected choices, represented as indexes into the * choices list. * * @see #setSelectedIndexes */ public int[] getSelectedIndexes() { return selections; } }