Files
Paper/paper-api/src/main/java/org/bukkit/conversations/NumericPrompt.java
2019-03-13 17:42:57 +11:00

90 lines
3.2 KiB
Java

package org.bukkit.conversations;
import org.apache.commons.lang.math.NumberUtils;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
/**
* 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() {
super();
}
@Override
protected boolean isInputValid(@NotNull ConversationContext context, @NotNull String input) {
return NumberUtils.isNumber(input) && isNumberValid(context, NumberUtils.createNumber(input));
}
/**
* 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.
* @return The validity of the player's input.
*/
protected boolean isNumberValid(@NotNull ConversationContext context, @NotNull Number input) {
return true;
}
@Nullable
@Override
protected Prompt acceptValidatedInput(@NotNull ConversationContext context, @NotNull String input) {
try {
return acceptValidatedInput(context, NumberUtils.createNumber(input));
} catch (NumberFormatException e) {
return acceptValidatedInput(context, NumberUtils.INTEGER_ZERO);
}
}
/**
* 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}.
* @return The next {@link Prompt} in the prompt graph.
*/
@Nullable
protected abstract Prompt acceptValidatedInput(@NotNull ConversationContext context, @NotNull Number input);
@Nullable
@Override
protected String getFailedValidationText(@NotNull ConversationContext context, @NotNull String invalidInput) {
if (NumberUtils.isNumber(invalidInput)) {
return getFailedValidationText(context, NumberUtils.createNumber(invalidInput));
} else {
return getInputNotNumericText(context, invalidInput);
}
}
/**
* 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.
* @return A message explaining how to correct the input.
*/
@Nullable
protected String getInputNotNumericText(@NotNull ConversationContext context, @NotNull String invalidInput) {
return null;
}
/**
* 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.
* @return A message explaining how to correct the input.
*/
@Nullable
protected String getFailedValidationText(@NotNull ConversationContext context, @NotNull Number invalidInput) {
return null;
}
}