org.bukkit.conversations
Class NumericPrompt

java.lang.Object
  extended by org.bukkit.conversations.ValidatingPrompt
      extended by org.bukkit.conversations.NumericPrompt
All Implemented Interfaces:
Cloneable, Prompt

public abstract class NumericPrompt
extends ValidatingPrompt

NumericPrompt is the base class for any prompt that requires a Number response from the user.


Field Summary
 
Fields inherited from interface org.bukkit.conversations.Prompt
END_OF_CONVERSATION
 
Constructor Summary
NumericPrompt()
           
 
Method Summary
protected abstract  Prompt acceptValidatedInput(ConversationContext context, Number input)
          Override this method to perform some action with the user's integer response.
protected  Prompt acceptValidatedInput(ConversationContext context, String input)
          Override this method to accept and processes the validated input from the user.
protected  String getFailedValidationText(ConversationContext context, Number invalidInput)
          Optionally override this method to display an additional message if the user enters an invalid numeric input.
protected  String getFailedValidationText(ConversationContext context, String invalidInput)
          Optionally override this method to display an additional message if the user enters an invalid input.
protected  String getInputNotNumericText(ConversationContext context, String invalidInput)
          Optionally override this method to display an additional message if the user enters an invalid number.
protected  boolean isInputValid(ConversationContext context, String input)
          Override this method to check the validity of the player's input.
protected  boolean isNumberValid(ConversationContext context, Number input)
          Override this method to do further validation on the numeric player input after the input has been determined to actually be a number.
 
Methods inherited from class org.bukkit.conversations.ValidatingPrompt
acceptInput, blocksForInput
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.bukkit.conversations.Prompt
getPromptText
 

Constructor Detail

NumericPrompt

public NumericPrompt()
Method Detail

isInputValid

protected boolean isInputValid(ConversationContext context,
                               String input)
Description copied from class: ValidatingPrompt
Override this method to check the validity of the player's input.

Specified by:
isInputValid in class ValidatingPrompt
Parameters:
context - Context information about the conversation.
input - The player's raw console input.
Returns:
True or false depending on the validity of the input.

isNumberValid

protected boolean isNumberValid(ConversationContext context,
                                Number input)
Override this method to do further validation on the numeric player input after the input has been determined to actually be a number.

Parameters:
context - Context information about the conversation.
input - The number the player provided.
Returns:
The validity of the player's input.

acceptValidatedInput

protected Prompt acceptValidatedInput(ConversationContext context,
                                      String input)
Description copied from class: ValidatingPrompt
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.

Specified by:
acceptValidatedInput in class ValidatingPrompt
Parameters:
context - Context information about the conversation.
input - The validated input text from the user.
Returns:
The next Prompt in the prompt graph.

acceptValidatedInput

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

Parameters:
context - Context information about the conversation.
input - The user's response as a Number.
Returns:
The next Prompt in the prompt graph.

getFailedValidationText

protected String getFailedValidationText(ConversationContext context,
                                         String invalidInput)
Description copied from class: ValidatingPrompt
Optionally override this method to display an additional message if the user enters an invalid input.

Overrides:
getFailedValidationText in class ValidatingPrompt
Parameters:
context - Context information about the conversation.
invalidInput - The invalid input provided by the user.
Returns:
A message explaining how to correct the input.

getInputNotNumericText

protected String getInputNotNumericText(ConversationContext context,
                                        String invalidInput)
Optionally override this method to display an additional message if the user enters an invalid number.

Parameters:
context - Context information about the conversation.
invalidInput - The invalid input provided by the user.
Returns:
A message explaining how to correct the input.

getFailedValidationText

protected String getFailedValidationText(ConversationContext context,
                                         Number invalidInput)
Optionally override this method to display an additional message if the user enters an invalid numeric input.

Parameters:
context - Context information about the conversation.
invalidInput - The invalid input provided by the user.
Returns:
A message explaining how to correct the input.


Copyright © 2013. All Rights Reserved.