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.


javax.security.auth.callback
class TextInputCallback

java.lang.Object extended by javax.security.auth.callback.TextInputCallback
All Implemented Interfaces:
Serializable, Callback
Direct Known Subclasses:
RealmCallback

Most common way to construct:

TextInputCallback t = new TextInputCallback("prmpt", "defText");

Based on 6 examples


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.


Constructor Summary

          Construct a TextInputCallback with a prompt.
TextInputCallback(String prompt, String defaultText)

          Construct a TextInputCallback with a prompt and default input value.
 
Method Summary
 String

          Get the default text.
 String

          Get the prompt.
 String

          Get the retrieved text.
 void

          Set the retrieved text.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

TextInputCallback

public TextInputCallback(String prompt)
Construct a TextInputCallback with a prompt.

Parameters:
prompt - the prompt used to request the information.

TextInputCallback

public TextInputCallback(String prompt,
                         String defaultText)
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.
Method Detail

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.


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.
This page displays the Jadeite version of the documention, which is derived from the offical documentation that contains this copyright notice:
Copyright 2008 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
The official Sun™ documentation can be found here at http://java.sun.com/javase/6/docs/api/.