Package org.bukkit.conversations

Class PlayerNamePrompt

java.lang.Object

org.bukkit.conversations.ValidatingPrompt

org.bukkit.conversations.PlayerNamePrompt

All Implemented Interfaces:

Cloneable, Prompt

public abstract class PlayerNamePrompt
extends ValidatingPrompt

PlayerNamePrompt is the base class for any prompt that requires the player to enter another player's name.

Field Summary

Fields inherited from interface org.bukkit.conversations.Prompt

END_OF_CONVERSATION

Constructor Summary

Constructors

Constructor	Description
PlayerNamePrompt(Plugin plugin)

Method Summary

Modifier and Type	Method	Description
protected Prompt	acceptValidatedInput(ConversationContext context, String input)	Override this method to accept and processes the validated input from the user.
protected abstract Prompt	acceptValidatedInput(ConversationContext context, Player input)	Override this method to perform some action with the user's player name response.
protected boolean	isInputValid(ConversationContext context, String input)	Override this method to check the validity of the player's input.

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

Methods inherited from class org.bukkit.conversations.ValidatingPrompt

acceptInput, blocksForInput, getFailedValidationText

Constructor Detail

PlayerNamePrompt

public PlayerNamePrompt(@NotNull
                        Plugin plugin)

Method Detail

isInputValid

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

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.

acceptValidatedInput

@Nullable
protected Prompt acceptValidatedInput(@NotNull
                                      ConversationContext context,
                                      @NotNull
                                      String input)

Description copied from class: ValidatingPrompt

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.

Specified by:

acceptValidatedInput in class ValidatingPrompt

Parameters:

context - Context information about the conversation.

input - The validated input text from the user.

Returns:

The next Prompt in the prompt graph.

acceptValidatedInput

@Nullable
protected abstract Prompt acceptValidatedInput(@NotNull
                                               ConversationContext context,
                                               @NotNull
                                               Player input)

Override this method to perform some action with the user's player name response.

Parameters:

context - Context information about the conversation.

input - The user's player name response.

Returns:

The next Prompt in the prompt graph.