java.lang.Object

org.bukkit.conversations.ExactMatchConversationCanceller

All Implemented Interfaces:: Cloneable, ConversationCanceller

public class ExactMatchConversationCanceller extends Object implements ConversationCanceller

An ExactMatchConversationCanceller cancels a conversation if the user enters an exact input string

Constructor Summary

Constructors

Constructor

Description

ExactMatchConversationCanceller(String escapeSequence)

Builds an ExactMatchConversationCanceller.
Method Summary

Modifier and Type

Method

Description

boolean

cancelBasedOnInput(ConversationContext context, String input)

Cancels a conversation based on user input.

ConversationCanceller

clone()

Allows the ConversationFactory to duplicate this ConversationCanceller when creating a new Conversation.

void

setConversation(Conversation conversation)

Sets the conversation this ConversationCanceller can optionally cancel.

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details
- ExactMatchConversationCanceller
  
  public ExactMatchConversationCanceller(@NotNull String escapeSequence)
  
  Builds an ExactMatchConversationCanceller.
  
  Parameters:
  
  escapeSequence - The string that, if entered by the user, will cancel the conversation.
Method Details
- setConversation
  
  public void setConversation(@NotNull Conversation conversation)
  
  Description copied from interface: ConversationCanceller
  
  Sets the conversation this ConversationCanceller can optionally cancel.
  
  Specified by:
  
  setConversation in interface ConversationCanceller
  
  Parameters:
  
  conversation - A conversation.
- cancelBasedOnInput
  
  public boolean cancelBasedOnInput(@NotNull ConversationContext context, @NotNull String input)
  
  Description copied from interface: ConversationCanceller
  
  Cancels a conversation based on user input.
  
  Specified by:
  
  cancelBasedOnInput in interface ConversationCanceller
  
  Parameters:
  
  context - Context information about the conversation.
  
  input - The input text from the user.
  
  Returns:
  
  True to cancel the conversation, False otherwise.
- clone
  
  @NotNull public ConversationCanceller clone()
  
  Description copied from interface: ConversationCanceller
  
  Allows the ConversationFactory to duplicate this ConversationCanceller when creating a new Conversation.
  Implementing this method should reset any internal object state.
  
  Specified by:
  
  clone in interface ConversationCanceller
  
  Overrides:
  
  clone in class Object
  
  Returns:
  
  A clone.

Class ExactMatchConversationCanceller

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Details

ExactMatchConversationCanceller

Method Details

setConversation

cancelBasedOnInput

clone