Package org.bukkit.conversations

Class RegexPrompt

java.lang.Object

org.bukkit.conversations.ValidatingPrompt

org.bukkit.conversations.RegexPrompt

All Implemented Interfaces:

Cloneable, Prompt

@Deprecated(forRemoval=true)
public abstract class RegexPrompt
extends ValidatingPrompt

Deprecated, for removal: This API element is subject to removal in a future version.

The conversation API has been deprecated for removal. This system does not support component based messages and has been slowly losing functionality over the years as Minecraft has changed that this API can not adapt to. It is recommended you instead manually listen to the AsyncChatEvent or alternatively using Dialog to get user input.

RegexPrompt is the base class for any prompt that requires an input validated by a regular expression.

Field Summary

Fields inherited from interface org.bukkit.conversations.Prompt

END_OF_CONVERSATION

Constructor Summary

Constructors

Constructor	Description
RegexPrompt(@NotNull String regex)	Deprecated, for removal: This API element is subject to removal in a future version.
RegexPrompt(@NotNull Pattern pattern)	Deprecated, for removal: This API element is subject to removal in a future version.

Method Summary

Modifier and Type	Method	Description
protected boolean	isInputValid(@NotNull ConversationContext context, @NotNull String input)	Deprecated, for removal: This API element is subject to removal in a future version. Override this method to check the validity of the player's input.

Methods inherited from class org.bukkit.conversations.ValidatingPrompt

acceptInput, acceptValidatedInput, blocksForInput, getFailedValidationText

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 Details

RegexPrompt

public RegexPrompt(@NotNull
 @NotNull String regex)

Deprecated, for removal: This API element is subject to removal in a future version.

RegexPrompt

public RegexPrompt(@NotNull
 @NotNull Pattern pattern)

Deprecated, for removal: This API element is subject to removal in a future version.

Method Details

isInputValid

protected boolean isInputValid(@NotNull
 @NotNull ConversationContext context,
 @NotNull
 @NotNull String input)

Deprecated, for removal: This API element is subject to removal in a future version.

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.