Pulling all pending Bukkit-JavaDoc changes

By: Edmond Poon <sagaciouszzzz@gmail.com>
This commit is contained in:
Bukkit/Spigot
2013-08-03 21:46:30 -04:00
parent b9642786eb
commit 599ec05858
80 changed files with 259 additions and 43 deletions

View File

@@ -14,6 +14,7 @@ public abstract class ValidatingPrompt implements Prompt {
/**
* Accepts and processes input from the user and validates it. If validation fails, this prompt is returned for
* re-execution, otherwise the next Prompt in the prompt graph is returned.
*
* @param context Context information about the conversation.
* @param input The input text from the user.
* @return This prompt or the next Prompt in the prompt graph.
@@ -33,6 +34,7 @@ public abstract class ValidatingPrompt implements Prompt {
/**
* Ensures that the prompt waits for the user to provide input.
*
* @param context Context information about the conversation.
* @return True.
*/
@@ -42,6 +44,7 @@ public abstract class ValidatingPrompt implements Prompt {
/**
* Override this method to check the validity of the player's input.
*
* @param context Context information about the conversation.
* @param input The player's raw console input.
* @return True or false depending on the validity of the input.
@@ -51,6 +54,7 @@ public abstract class ValidatingPrompt implements Prompt {
/**
* 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.
*
* @param context Context information about the conversation.
* @param input The validated input text from the user.
* @return The next Prompt in the prompt graph.
@@ -59,6 +63,7 @@ public abstract class ValidatingPrompt implements Prompt {
/**
* Optionally override this method to display an additional message if the user enters an invalid input.
*
* @param context Context information about the conversation.
* @param invalidInput The invalid input provided by the user.
* @return A message explaining how to correct the input.