BooleanPrompt is the base class for any prompt that requires a boolean response from the user. More...

Inheritance diagram for org.bukkit.conversations.BooleanPrompt:

Collaboration diagram for org.bukkit.conversations.BooleanPrompt:

Public Member Functions
	BooleanPrompt ()

Public Member Functions inherited from org.bukkit.conversations.ValidatingPrompt
	ValidatingPrompt ()

Prompt	acceptInput (ConversationContext context, String input)
	Accepts and processes input from the user and validates it.

boolean	blocksForInput (ConversationContext context)
	Ensures that the prompt waits for the user to provide input.

Public Member Functions inherited from org.bukkit.conversations.Prompt
String	getPromptText (ConversationContext context)
	Gets the text to display to the user when this prompt is first presented.

boolean	blocksForInput (ConversationContext context)
	Checks to see if this prompt implementation should wait for user input or immediately display the next prompt.

Prompt	acceptInput (ConversationContext context, String input)
	Accepts and processes input from the user.

Protected Member Functions
boolean	isInputValid (ConversationContext context, String input)
	Override this method to check the validity of the player's input.

Prompt	acceptValidatedInput (ConversationContext context, String input)
	Override this method to accept and processes the validated input from the user.

abstract Prompt	acceptValidatedInput (ConversationContext context, boolean input)
	Override this method to perform some action with the user's boolean response.

Protected Member Functions inherited from org.bukkit.conversations.ValidatingPrompt
String	getFailedValidationText (ConversationContext context, String invalidInput)
	Optionally override this method to display an additional message if the user enters an invalid input.

Additional Inherited Members
Static Public Attributes inherited from org.bukkit.conversations.Prompt
static final Prompt	END_OF_CONVERSATION = null
	A convenience constant for indicating the end of a conversation.

Detailed Description

BooleanPrompt is the base class for any prompt that requires a boolean response from the user.

Definition at line 9 of file BooleanPrompt.java.

Constructor & Destructor Documentation

org.bukkit.conversations.BooleanPrompt.BooleanPrompt ( )

Definition at line 11 of file BooleanPrompt.java.

Prompt org.bukkit.conversations.BooleanPrompt.acceptValidatedInput	(	ConversationContext	context,
		String	input
	)

protectedvirtual

Override this method to accept and processes the validated input from the user.

Using the input, the next Prompt in the prompt graph should be returned.

Parameters

context	Context information about the conversation.
input	The validated input text from the user.

Definition at line 22 of file BooleanPrompt.java.

abstract Prompt org.bukkit.conversations.BooleanPrompt.acceptValidatedInput	(	ConversationContext	context,
		boolean	input
	)

protectedpure virtual

Override this method to perform some action with the user's boolean response.

Parameters

context	Context information about the conversation.
input	The user's boolean response.

boolean org.bukkit.conversations.BooleanPrompt.isInputValid	(	ConversationContext	context,
		String	input
	)

protectedvirtual

Override this method to check the validity of the player's input.

Parameters

context	Context information about the conversation.
input	The player's raw console input.

Definition at line 16 of file BooleanPrompt.java.

The documentation for this class was generated from the following file: