Record Class InvocationContext<T extends GenericInteractionCreateEvent>

java.lang.Object

java.lang.Record

io.github.kaktushose.jdac.dispatching.context.InvocationContext<T>

Type Parameters:

T - The used type of GenericInteractionCreateEvent

Record Components:

util - A set of framework functionalities exposed to the user, including I18n etc.

data - The data hold by this InvocationContext, including the event, interaction definition etc.

All Implemented Interfaces:

ErrorMessageFactory.ErrorContext

public record InvocationContext<T extends GenericInteractionCreateEvent>(InvocationContext.Utility util, InvocationContext.Data<T extends GenericInteractionCreateEvent> data)
extends Record
implements ErrorMessageFactory.ErrorContext

Bundles data that is important for the execution of an interaction, especially for invoking the user defined method.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	InvocationContext.Data<T extends GenericInteractionCreateEvent>	An object holding data exposed to the user that is crucial for invoking the user defined method.
static final record	InvocationContext.Utility	An object providing access to some framework functionality.

Constructor Summary

Constructors

Constructor	Description
InvocationContext(InvocationContext.Utility util, InvocationContext.Data<T> data)	Creates an instance of a InvocationContext record class.

Method Summary

Modifier and Type	Method	Description
SequencedCollection<@Nullable Object>	arguments()
void	cancel(MessageCreateData errorMessage)	Stops further execution of this invocation at the next suitable moment.
boolean	cancelled()
InvocationContext.Data<T>	data()	Returns the value of the data record component.
InteractionDefinition	definition()	The InteractionDefinition that models the interaction of the ErrorMessageFactory.ErrorContext.event().
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
GenericInteractionCreateEvent	event()	The GenericInteractionCreateEvent in whose execution the error occurred.
final int	hashCode()	Returns a hash code value for this object.
final String	toString()	Returns a string representation of this record class.
InvocationContext.Utility	util()	Returns the value of the util record component.

Methods inherited from class Object

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

Constructor Details

InvocationContext

public InvocationContext(InvocationContext.Utility util,
 InvocationContext.Data<T> data)

Creates an instance of a InvocationContext record class.

Parameters:

util - the value for the util record component

data - the value for the data record component

Method Details

event

public GenericInteractionCreateEvent event()

Description copied from interface: ErrorMessageFactory.ErrorContext

The GenericInteractionCreateEvent in whose execution the error occurred.

Specified by:

event in interface ErrorMessageFactory.ErrorContext

definition

public InteractionDefinition definition()

Description copied from interface: ErrorMessageFactory.ErrorContext

The InteractionDefinition that models the interaction of the ErrorMessageFactory.ErrorContext.event().

Specified by:

definition in interface ErrorMessageFactory.ErrorContext

arguments

public SequencedCollection<@Nullable Object> arguments()

Returns:

same as data()#rawArguements but with Optionals replaced by null

cancel

public void cancel(MessageCreateData errorMessage)

Stops further execution of this invocation at the next suitable moment.

Parameters:

errorMessage - the error message that should be sent to the user as a reply

Implementation Note:

This will interrupt the current event thread

cancelled

public boolean cancelled()

Returns:

if the current invocation is cancelled

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. All components in this record class are compared with Objects::equals(Object,Object).

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.

util

public InvocationContext.Utility util()

Returns the value of the util record component.

Returns:

the value of the util record component

data

public InvocationContext.Data<T> data()

Returns the value of the data record component.

Returns:

the value of the data record component