org.bukkit.conversations

クラス InactivityConversationCanceller

java.lang.Object

org.bukkit.conversations.InactivityConversationCanceller

すべての実装されたインタフェース:

Cloneable, ConversationCanceller

public class InactivityConversationCanceller
extends Object
implements ConversationCanceller

An InactivityConversationCanceller will cancel a Conversation after a period of inactivity by the user.

フィールドのサマリー

フィールド

修飾子とタイプ	フィールドと説明
protected Conversation	conversation
protected Plugin	plugin
protected int	timeoutSeconds

コンストラクタのサマリー

コンストラクタ

コンストラクタと説明
InactivityConversationCanceller(Plugin plugin, int timeoutSeconds) Creates an InactivityConversationCanceller.

メソッドのサマリー

修飾子とタイプ	メソッドと説明
boolean	cancelBasedOnInput(ConversationContext context, String input) Cancels a conversation based on user input.
protected void	cancelling(Conversation conversation) Subclasses of InactivityConversationCanceller can override this method to take additional actions when the inactivity timer abandons the conversation.
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.

クラスから継承されたメソッド java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

フィールドの詳細

plugin

protected Plugin plugin

timeoutSeconds

protected int timeoutSeconds

conversation

protected Conversation conversation

コンストラクタの詳細

InactivityConversationCanceller

public InactivityConversationCanceller(Plugin plugin,
                                       int timeoutSeconds)

Creates an InactivityConversationCanceller.

パラメータ:

plugin - The owning plugin.

timeoutSeconds - The number of seconds of inactivity to wait.

メソッドの詳細

setConversation

public void setConversation(Conversation conversation)

インタフェースからコピーされた説明: ConversationCanceller

Sets the conversation this ConversationCanceller can optionally cancel.

定義:

setConversation インタフェース内 ConversationCanceller

パラメータ:

conversation - A conversation.

cancelBasedOnInput

public boolean cancelBasedOnInput(ConversationContext context,
                                  String input)

インタフェースからコピーされた説明: ConversationCanceller

Cancels a conversation based on user input.

定義:

cancelBasedOnInput インタフェース内 ConversationCanceller

パラメータ:

context - Context information about the conversation.

input - The input text from the user.

戻り値:

True to cancel the conversation, False otherwise.

clone

public ConversationCanceller clone()

インタフェースからコピーされた説明: ConversationCanceller

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

Implementing this method should reset any internal object state.

定義:

clone インタフェース内 ConversationCanceller

オーバーライド:

clone クラス内 Object

戻り値:

A clone.

cancelling

protected void cancelling(Conversation conversation)

Subclasses of InactivityConversationCanceller can override this method to take additional actions when the inactivity timer abandons the conversation.

パラメータ:

conversation - The conversation being abandoned.