Pulling all pending Bukkit-JavaDoc changes
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:
@@ -3,7 +3,8 @@ package org.bukkit.conversations;
|
||||
import org.apache.commons.lang.math.NumberUtils;
|
||||
|
||||
/**
|
||||
* NumericPrompt is the base class for any prompt that requires a {@link Number} response from the user.
|
||||
* NumericPrompt is the base class for any prompt that requires a {@link
|
||||
* Number} response from the user.
|
||||
*/
|
||||
public abstract class NumericPrompt extends ValidatingPrompt{
|
||||
public NumericPrompt() {
|
||||
@@ -16,8 +17,8 @@ public abstract class NumericPrompt extends ValidatingPrompt{
|
||||
}
|
||||
|
||||
/**
|
||||
* Override this method to do further validation on the numeric player input after the input has been determined
|
||||
* to actually be a number.
|
||||
* Override this method to do further validation on the numeric player
|
||||
* input after the input has been determined to actually be a number.
|
||||
*
|
||||
* @param context Context information about the conversation.
|
||||
* @param input The number the player provided.
|
||||
@@ -38,7 +39,8 @@ public abstract class NumericPrompt extends ValidatingPrompt{
|
||||
}
|
||||
|
||||
/**
|
||||
* Override this method to perform some action with the user's integer response.
|
||||
* Override this method to perform some action with the user's integer
|
||||
* response.
|
||||
*
|
||||
* @param context Context information about the conversation.
|
||||
* @param input The user's response as a {@link Number}.
|
||||
@@ -56,7 +58,8 @@ public abstract class NumericPrompt extends ValidatingPrompt{
|
||||
}
|
||||
|
||||
/**
|
||||
* Optionally override this method to display an additional message if the user enters an invalid number.
|
||||
* Optionally override this method to display an additional message if the
|
||||
* user enters an invalid number.
|
||||
*
|
||||
* @param context Context information about the conversation.
|
||||
* @param invalidInput The invalid input provided by the user.
|
||||
@@ -67,7 +70,8 @@ public abstract class NumericPrompt extends ValidatingPrompt{
|
||||
}
|
||||
|
||||
/**
|
||||
* Optionally override this method to display an additional message if the user enters an invalid numeric input.
|
||||
* Optionally override this method to display an additional message if the
|
||||
* user enters an invalid numeric input.
|
||||
*
|
||||
* @param context Context information about the conversation.
|
||||
* @param invalidInput The invalid input provided by the user.
|
||||
|
||||
Reference in New Issue
Block a user