Package com.jackdaw.chatwithnpc.openaiapi

Class Run.RunResult

java.lang.Object

com.jackdaw.chatwithnpc.openaiapi.Run.RunResult

All Implemented Interfaces:

AsyncTask.TaskResult

Enclosing class:

Run

public static class Run.RunResult
extends Object
implements AsyncTask.TaskResult

Represents the result of a Run request.

Field Summary

Fields

Modifier and Type	Field	Description
private final @Nullable ConversationHandler	conversation
private final @Nullable Run	run

Constructor Summary

Constructors

Constructor	Description
RunResult(@Nullable ConversationHandler conversation, @Nullable Run run)

Method Summary

Modifier and Type	Method	Description
void	execute()	Executes the RunResult by calling the functions and replying to the conversation.
boolean	isCallable()	Returns whether the RunResult is callable.
(package private) static @NotNull Run.RunResult	nothingToDo()	Returns a RunResult that does nothing.

Methods inherited from class java.lang.Object

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

Field Details

conversation

@Nullable
private final @Nullable ConversationHandler conversation

run

@Nullable
private final @Nullable Run run

Constructor Details

RunResult

RunResult(@Nullable
 @Nullable ConversationHandler conversation,
 @Nullable
 @Nullable Run run)

Method Details

execute

public void execute()

Executes the RunResult by calling the functions and replying to the conversation.

Specified by:

execute in interface AsyncTask.TaskResult

isCallable

public boolean isCallable()

Returns whether the RunResult is callable. A RunResult is callable if it has a Run and a ConversationHandler and the Run should require an action.

Specified by:

isCallable in interface AsyncTask.TaskResult

Returns:

True if the RunResult is callable, false otherwise.

nothingToDo

@Contract(value=" -> new",
          pure=true)
@NotNull
static @NotNull Run.RunResult nothingToDo()

Returns a RunResult that does nothing. This is used when there is nothing to do after a Run request has been made

Returns:

A RunResult that does nothing.