Overview Package Class Use Source Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

javax.security.auth.callback

Class TextInputCallback

Implemented Interfaces:
Callback, Serializable
Known Direct Subclasses:
RealmCallback
public class TextInputCallback
extends Object
implements Callback, Serializable
Underlying security services instantiate and pass a TextInputCallback to the handle() method of a CallbackHandler to retrieve generic text information.
See Also:
CallbackHandler, Serialized Form

Constructor Summary

TextInputCallback(String prompt)
Construct a TextInputCallback with a prompt.
TextInputCallback(String prompt, String defaultText)
Construct a TextInputCallback with a prompt and default input value.

Method Summary

String
getDefaultText()
Get the default text.
String
getPrompt()
Get the prompt.
String
getText()
Get the retrieved text.
void
setText(String text)
Set the retrieved text.

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

TextInputCallback

public TextInputCallback(String prompt)
            throws IllegalArgumentException
Construct a TextInputCallback with a prompt.
Parameters:
prompt - the prompt used to request the information.
Throws:
IllegalArgumentException - if prompt is null or if prompt has a length of 0.

TextInputCallback

public TextInputCallback(String prompt,
                         String defaultText)
            throws IllegalArgumentException
Construct a TextInputCallback with a prompt and default input value.
Parameters:
prompt - the prompt used to request the information.
defaultText - the text to be used as the default text displayed with the prompt.
Throws:
IllegalArgumentException - if prompt is null, if prompt has a length of 0, if defaultText is null or if defaultText has a length of 0.

Method Details

getDefaultText

public String getDefaultText()
Get the default text.
Returns:
the default text, or null if this TextInputCallback was not instantiated with defaultText.

getPrompt

public String getPrompt()
Get the prompt.
Returns:
the prompt.

getText

public String getText()
Get the retrieved text.
Returns:
the retrieved text, which may be null.

setText

public void setText(String text)
Set the retrieved text.
Parameters:
text - the retrieved text, which may be null.
TextInputCallback.java -- callbacks for user input. Copyright (C) 2003, Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.

Overview Package Class Use Source Tree Index Deprecated About