Package org.bukkit.conversations
Class ExactMatchConversationCanceller
java.lang.Object
org.bukkit.conversations.ExactMatchConversationCanceller
- All Implemented Interfaces:
Cloneable
,ConversationCanceller
An ExactMatchConversationCanceller cancels a conversation if the user
enters an exact input string
-
Constructor Summary
ConstructorDescriptionExactMatchConversationCanceller
(@NotNull String escapeSequence) Builds an ExactMatchConversationCanceller. -
Method Summary
Modifier and TypeMethodDescriptionboolean
cancelBasedOnInput
(@NotNull ConversationContext context, @NotNull String input) Cancels a conversation based on user input.clone()
Allows theConversationFactory
to duplicate this ConversationCanceller when creating a newConversation
.void
setConversation
(@NotNull Conversation conversation) Sets the conversation this ConversationCanceller can optionally cancel.
-
Constructor Details
-
ExactMatchConversationCanceller
Builds an ExactMatchConversationCanceller.- Parameters:
escapeSequence
- The string that, if entered by the user, will cancel the conversation.
-
-
Method Details
-
setConversation
Description copied from interface:ConversationCanceller
Sets the conversation this ConversationCanceller can optionally cancel.- Specified by:
setConversation
in interfaceConversationCanceller
- Parameters:
conversation
- A conversation.
-
cancelBasedOnInput
public boolean cancelBasedOnInput(@NotNull @NotNull ConversationContext context, @NotNull @NotNull String input) Description copied from interface:ConversationCanceller
Cancels a conversation based on user input.- Specified by:
cancelBasedOnInput
in interfaceConversationCanceller
- Parameters:
context
- Context information about the conversation.input
- The input text from the user.- Returns:
- True to cancel the conversation, False otherwise.
-
clone
Description copied from interface:ConversationCanceller
Allows theConversationFactory
to duplicate this ConversationCanceller when creating a newConversation
.Implementing this method should reset any internal object state.
- Specified by:
clone
in interfaceConversationCanceller
- Overrides:
clone
in classObject
- Returns:
- A clone.
-