org.bukkit.conversations.ConversationFactory Class Reference

A ConversationFactory is responsible for creating a Conversation from a predefined template. More...

Collaboration diagram for org.bukkit.conversations.ConversationFactory:

Public Member Functions
	ConversationFactory (Plugin plugin)
	Constructs a ConversationFactory.
ConversationFactory	withModality (boolean modal)
	Sets the modality of all Conversations created by this factory.
ConversationFactory	withLocalEcho (boolean localEchoEnabled)
	Sets the local echo status for all Conversations created by this factory.
ConversationFactory	withPrefix (ConversationPrefix prefix)
	Sets the ConversationPrefix that prepends all output from all generated conversations.
ConversationFactory	withTimeout (int timeoutSeconds)
	Sets the number of inactive seconds to wait before automatically abandoning all generated conversations.
ConversationFactory	withFirstPrompt (Prompt firstPrompt)
	Sets the first prompt to use in all generated conversations.
ConversationFactory	withInitialSessionData (Map< Object, Object > initialSessionData)
	Sets any initial data with which to populate the conversation context sessionData map.
ConversationFactory	withEscapeSequence (String escapeSequence)
	Sets the player input that, when received, will immediately terminate the conversation.
ConversationFactory	withConversationCanceller (ConversationCanceller canceller)
	Adds a to constructed conversations.
ConversationFactory	thatExcludesNonPlayersWithMessage (String playerOnlyMessage)
	Prevents this factory from creating a conversation for non-player Conversable objects.
ConversationFactory	addConversationAbandonedListener (ConversationAbandonedListener listener)
	Adds a ConversationAbandonedListener to all conversations constructed by this factory.
Conversation	buildConversation (Conversable forWhom)
	Constructs a Conversation in accordance with the defaults set for this factory.

Protected Attributes
Plugin	plugin
boolean	isModal
boolean	localEchoEnabled
ConversationPrefix	prefix
Prompt	firstPrompt
Map< Object, Object >	initialSessionData
String	playerOnlyMessage
List< ConversationCanceller >	cancellers
List < ConversationAbandonedListener >	abandonedListeners

Detailed Description

A ConversationFactory is responsible for creating a Conversation from a predefined template.

A ConversationFactory is typically created when a plugin is instantiated and builds a Conversation each time a user initiates a conversation with the plugin. Each Conversation maintains its own state and calls back as needed into the plugin.

The ConversationFactory implements a fluid API, allowing parameters to be set as an extension to the constructor.

Definition at line 18 of file ConversationFactory.java.

Constructor & Destructor Documentation

org.bukkit.conversations.ConversationFactory.ConversationFactory

(

Plugin

plugin

)

Constructs a ConversationFactory.

Parameters

plugin

The plugin that owns the factory.

Definition at line 34 of file ConversationFactory.java.

References org.bukkit.conversations.ConversationFactory.abandonedListeners, org.bukkit.conversations.ConversationFactory.cancellers, org.bukkit.conversations.Prompt.END_OF_CONVERSATION, org.bukkit.conversations.ConversationFactory.firstPrompt, org.bukkit.conversations.ConversationFactory.initialSessionData, org.bukkit.conversations.ConversationFactory.isModal, org.bukkit.conversations.ConversationFactory.localEchoEnabled, org.bukkit.conversations.ConversationFactory.playerOnlyMessage, org.bukkit.conversations.ConversationFactory.plugin, and org.bukkit.conversations.ConversationFactory.prefix.

Member Function Documentation

ConversationFactory org.bukkit.conversations.ConversationFactory.addConversationAbandonedListener

(

ConversationAbandonedListener

listener

)

Adds a ConversationAbandonedListener to all conversations constructed by this factory.

Parameters

listener

The listener to add.

Returns

This object.

Definition at line 152 of file ConversationFactory.java.

References org.bukkit.conversations.ConversationFactory.abandonedListeners.

Conversation org.bukkit.conversations.ConversationFactory.buildConversation

(

Conversable

forWhom

)

Constructs a Conversation in accordance with the defaults set for this factory.

Parameters

forWhom

The entity for whom the new conversation is mediating.

Returns

A new conversation.

Definition at line 162 of file ConversationFactory.java.

References org.bukkit.conversations.ConversationFactory.abandonedListeners, org.bukkit.conversations.Conversation.addConversationAbandonedListener(), org.bukkit.conversations.ConversationFactory.cancellers, org.bukkit.conversations.ConversationFactory.firstPrompt, org.bukkit.conversations.ConversationFactory.initialSessionData, org.bukkit.conversations.ConversationFactory.isModal, org.bukkit.conversations.ConversationFactory.localEchoEnabled, org.bukkit.conversations.ConversationFactory.playerOnlyMessage, org.bukkit.conversations.ConversationFactory.plugin, org.bukkit.conversations.ConversationFactory.prefix, and org.bukkit.conversations.Conversation.setLocalEchoEnabled().

ConversationFactory org.bukkit.conversations.ConversationFactory.thatExcludesNonPlayersWithMessage

(

String

playerOnlyMessage

)

Prevents this factory from creating a conversation for non-player Conversable objects.

Parameters

playerOnlyMessage

The message to return to a non-play in lieu of starting a conversation.

Returns

This object.

Definition at line 142 of file ConversationFactory.java.

References org.bukkit.conversations.ConversationFactory.playerOnlyMessage.

ConversationFactory org.bukkit.conversations.ConversationFactory.withConversationCanceller

(

ConversationCanceller

canceller

)

Adds a to constructed conversations.

}

Parameters

canceller

The to add.

Returns

This object.

Definition at line 132 of file ConversationFactory.java.

References org.bukkit.conversations.ConversationFactory.cancellers.

Referenced by org.bukkit.conversations.ConversationFactory.withEscapeSequence(), and org.bukkit.conversations.ConversationFactory.withTimeout().

ConversationFactory org.bukkit.conversations.ConversationFactory.withEscapeSequence

(

String

escapeSequence

)

Sets the player input that, when received, will immediately terminate the conversation.

Parameters

escapeSequence

Input to terminate the conversation.

Returns

This object.

Definition at line 122 of file ConversationFactory.java.

References org.bukkit.conversations.ConversationFactory.withConversationCanceller().

ConversationFactory org.bukkit.conversations.ConversationFactory.withFirstPrompt

(

Prompt

firstPrompt

)

Sets the first prompt to use in all generated conversations.

The default is Prompt.END_OF_CONVERSATION.

Parameters

firstPrompt

The first prompt.

Returns

This object.

Definition at line 102 of file ConversationFactory.java.

References org.bukkit.conversations.ConversationFactory.firstPrompt.

ConversationFactory org.bukkit.conversations.ConversationFactory.withInitialSessionData

(

Map< Object, Object >

initialSessionData

)

Sets any initial data with which to populate the conversation context sessionData map.

Parameters

initialSessionData

The conversation context's initial sessionData.

Returns

This object.

Definition at line 112 of file ConversationFactory.java.

References org.bukkit.conversations.ConversationFactory.initialSessionData.

ConversationFactory org.bukkit.conversations.ConversationFactory.withLocalEcho

(

boolean

localEchoEnabled

)

Sets the local echo status for all Conversations created by this factory.

If local echo is enabled, any text submitted to a conversation gets echoed back into the submitter's chat window.

Parameters

localEchoEnabled

The status of local echo.

Returns

This object.

Definition at line 67 of file ConversationFactory.java.

References org.bukkit.conversations.ConversationFactory.localEchoEnabled.

ConversationFactory org.bukkit.conversations.ConversationFactory.withModality

(

boolean

modal

)

Sets the modality of all Conversations created by this factory.

If a conversation is modal, all messages directed to the player are suppressed for the duration of the conversation.

The default is True.

Parameters

modal

The modality of all conversations to be created.

Returns

This object.

Definition at line 55 of file ConversationFactory.java.

References org.bukkit.conversations.ConversationFactory.isModal.

ConversationFactory org.bukkit.conversations.ConversationFactory.withPrefix

(

ConversationPrefix

prefix

)

Sets the ConversationPrefix that prepends all output from all generated conversations.

The default is a NullConversationPrefix;

Parameters

prefix

The ConversationPrefix to use.

Returns

This object.

Definition at line 79 of file ConversationFactory.java.

References org.bukkit.conversations.ConversationFactory.prefix.

ConversationFactory org.bukkit.conversations.ConversationFactory.withTimeout

(

int

timeoutSeconds

)

Sets the number of inactive seconds to wait before automatically abandoning all generated conversations.

The default is 600 seconds (5 minutes).

Parameters

timeoutSeconds

The number of seconds to wait.

Returns

This object.

Definition at line 91 of file ConversationFactory.java.

References org.bukkit.conversations.ConversationFactory.plugin, and org.bukkit.conversations.ConversationFactory.withConversationCanceller().

Member Data Documentation

List<ConversationAbandonedListener> org.bukkit.conversations.ConversationFactory.abandonedListeners

protected

Definition at line 28 of file ConversationFactory.java.

Referenced by org.bukkit.conversations.ConversationFactory.addConversationAbandonedListener(), org.bukkit.conversations.ConversationFactory.buildConversation(), and org.bukkit.conversations.ConversationFactory.ConversationFactory().

List<ConversationCanceller> org.bukkit.conversations.ConversationFactory.cancellers

protected

Definition at line 27 of file ConversationFactory.java.

Referenced by org.bukkit.conversations.ConversationFactory.buildConversation(), org.bukkit.conversations.ConversationFactory.ConversationFactory(), and org.bukkit.conversations.ConversationFactory.withConversationCanceller().

Prompt org.bukkit.conversations.ConversationFactory.firstPrompt

protected

Definition at line 24 of file ConversationFactory.java.

Referenced by org.bukkit.conversations.ConversationFactory.buildConversation(), org.bukkit.conversations.ConversationFactory.ConversationFactory(), and org.bukkit.conversations.ConversationFactory.withFirstPrompt().

Map<Object, Object> org.bukkit.conversations.ConversationFactory.initialSessionData

protected

Definition at line 25 of file ConversationFactory.java.

Referenced by org.bukkit.conversations.ConversationFactory.buildConversation(), org.bukkit.conversations.ConversationFactory.ConversationFactory(), and org.bukkit.conversations.ConversationFactory.withInitialSessionData().

boolean org.bukkit.conversations.ConversationFactory.isModal

protected

Definition at line 21 of file ConversationFactory.java.

Referenced by org.bukkit.conversations.ConversationFactory.buildConversation(), org.bukkit.conversations.ConversationFactory.ConversationFactory(), and org.bukkit.conversations.ConversationFactory.withModality().

boolean org.bukkit.conversations.ConversationFactory.localEchoEnabled

protected

Definition at line 22 of file ConversationFactory.java.

Referenced by org.bukkit.conversations.ConversationFactory.buildConversation(), org.bukkit.conversations.ConversationFactory.ConversationFactory(), and org.bukkit.conversations.ConversationFactory.withLocalEcho().

String org.bukkit.conversations.ConversationFactory.playerOnlyMessage

protected

Definition at line 26 of file ConversationFactory.java.

Referenced by org.bukkit.conversations.ConversationFactory.buildConversation(), org.bukkit.conversations.ConversationFactory.ConversationFactory(), and org.bukkit.conversations.ConversationFactory.thatExcludesNonPlayersWithMessage().

Plugin org.bukkit.conversations.ConversationFactory.plugin

protected

Definition at line 20 of file ConversationFactory.java.

Referenced by org.bukkit.conversations.ConversationFactory.buildConversation(), org.bukkit.conversations.ConversationFactory.ConversationFactory(), and org.bukkit.conversations.ConversationFactory.withTimeout().

ConversationPrefix org.bukkit.conversations.ConversationFactory.prefix

protected

Definition at line 23 of file ConversationFactory.java.

Referenced by org.bukkit.conversations.ConversationFactory.buildConversation(), org.bukkit.conversations.ConversationFactory.ConversationFactory(), and org.bukkit.conversations.ConversationFactory.withPrefix().

---

The documentation for this class was generated from the following file:

• org/bukkit/conversations/ConversationFactory.java