Package org.teleight.teleightbots.conversation

Record Class Conversation

java.lang.Object

java.lang.Record

org.teleight.teleightbots.conversation.Conversation

Record Components:

name - the name of the conversation, used to identify the conversation. Must be unique.

executor - the executor of the conversation, see ConversationExecutor

properties - the properties of the conversation

instanceConstraints - the constraints of the conversation instance, see ConversationInstanceConstraints

allowUnknownProperties - whether unknown properties are allowed. By default, unknown properties are not allowed and will throw an exception.

public record Conversation(String name, ConversationExecutor executor, Map<String,Property<?>> properties, ConversationInstanceConstraints instanceConstraints, boolean allowUnknownProperties)
extends Record

A conversation represents a structured interaction between a bot and a user.

A conversation typically follows a sequence of exchanges (messages) where the bot prompts the user for input, processes the response, and decides on the next step.

A unique name identifies each conversation.

See Also:

• ConversationManager.registerConversation(Conversation)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Conversation.Builder

Constructor Summary

Constructors

Constructor	Description
Conversation(String name, ConversationExecutor executor, Map<String,Property<?>> properties, ConversationInstanceConstraints instanceConstraints, boolean allowUnknownProperties)	Creates an instance of a Conversation record class.

Method Summary

Modifier and Type	Method	Description
boolean	allowUnknownProperties()	Returns the value of the allowUnknownProperties record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
ConversationExecutor	executor()	Returns the value of the executor record component.
final int	hashCode()	Returns a hash code value for this object.
ConversationInstanceConstraints	instanceConstraints()	Returns the value of the instanceConstraints record component.
String	name()	Returns the value of the name record component.
static Conversation.Builder	ofBuilder(String name, ConversationExecutor executor)
Map<String,Property<?>>	properties()	Returns the value of the properties record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

Conversation

public Conversation(String name,
 ConversationExecutor executor,
 Map<String,Property<?>> properties,
 ConversationInstanceConstraints instanceConstraints,
 boolean allowUnknownProperties)

Creates an instance of a Conversation record class.

Parameters:

name - the value for the name record component

executor - the value for the executor record component

properties - the value for the properties record component

instanceConstraints - the value for the instanceConstraints record component

allowUnknownProperties - the value for the allowUnknownProperties record component

Method Details

ofBuilder

public static Conversation.Builder ofBuilder(String name,
 ConversationExecutor executor)

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

name

public String name()

Returns the value of the name record component.

Returns:

the value of the name record component

executor

public ConversationExecutor executor()

Returns the value of the executor record component.

Returns:

the value of the executor record component

properties

public Map<String,Property<?>> properties()

Returns the value of the properties record component.

Returns:

the value of the properties record component

instanceConstraints

public ConversationInstanceConstraints instanceConstraints()

Returns the value of the instanceConstraints record component.

Returns:

the value of the instanceConstraints record component

allowUnknownProperties

public boolean allowUnknownProperties()

Returns the value of the allowUnknownProperties record component.

Returns:

the value of the allowUnknownProperties record component