SteamWar/Paper
9
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Pulling all pending Bukkit-JavaDoc changes

Browse Source 
A special thanks goes to @aerouk for almost all of the changes found here.

By: Wesley Wolfe <weswolf@aol.com>
This commit is contained in:
Bukkit/Spigot
2013-12-15 01:07:43 -05:00
parent 800679913f
commit bb50f1a774
310 changed files with 4218 additions and 2904 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
paper-api/src/main/java/org/bukkit/conversations/ValidatingPrompt.java
View File

@@ -3,8 +3,9 @@ package org.bukkit.conversations;
import org.bukkit.ChatColor;
/**
* ValidatingPrompt is the base class for any prompt that requires validation. ValidatingPrompt will keep replaying
* the prompt text until the user enters a valid response.
* ValidatingPrompt is the base class for any prompt that requires validation.
* ValidatingPrompt will keep replaying the prompt text until the user enters
* a valid response.
*/
public abstract class ValidatingPrompt implements Prompt {
public ValidatingPrompt() {
@@ -12,8 +13,9 @@ 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.
* 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.
@@ -52,8 +54,9 @@ public abstract class ValidatingPrompt implements Prompt {
protected abstract boolean isInputValid(ConversationContext context, String input);
/**
* 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.
* 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.
@@ -62,7 +65,8 @@ public abstract class ValidatingPrompt implements Prompt {
protected abstract Prompt acceptValidatedInput(ConversationContext context, String input);
/**
* Optionally override this method to display an additional message if the user enters an invalid input.
* 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.