Record Class InvocationContext<T extends GenericInteractionCreateEvent>

java.lang.Object
java.lang.Record
com.github.kaktushose.jda.commands.dispatching.context.InvocationContext<T>
Type Parameters:
T - The used type of GenericInteractionCreateEvent
Record Components:
event - the underlying jda event
keyValueStore - the KeyValueStore belonging to this interaction over its whole lifetime
definition - the InteractionDefinition defining this interaction (referring to the user defined method)
arguments - the arguments used to call the final user defined method via Invokable.invoke(java.lang.Object, com.github.kaktushose.jda.commands.dispatching.context.InvocationContext)
All Implemented Interfaces:
ErrorMessageFactory.ErrorContext
public record InvocationContext<T extends GenericInteractionCreateEvent>(T extends GenericInteractionCreateEvent event, @NotNull KeyValueStore keyValueStore, @NotNull InteractionDefinition definition, @NotNull SequencedCollection<Object> arguments) extends Record implements ErrorMessageFactory.ErrorContext
Bundles data that is important for the execution of an interaction, especially for invoking the user defined method.

  • Constructor Details

    • InvocationContext

      public InvocationContext(@NotNull T event, @NotNull @NotNull KeyValueStore keyValueStore, @NotNull @NotNull InteractionDefinition definition, @NotNull @NotNull SequencedCollection<Object> arguments)
      Creates an instance of a InvocationContext record class.
      Parameters:
      event - the value for the event record component
      keyValueStore - the value for the keyValueStore record component
      definition - the value for the definition record component
      arguments - the value for the arguments record component

  • Method Details

    • cancel

      public void cancel(@NotNull @NotNull 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

    • 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.

    • event

      @NotNull public T event()
      Returns the value of the event record component.
      Specified by:
      event in interface ErrorMessageFactory.ErrorContext
      Returns:
      the value of the event record component

    • keyValueStore

      @NotNull public @NotNull KeyValueStore keyValueStore()
      Returns the value of the keyValueStore record component.
      Returns:
      the value of the keyValueStore record component

    • definition

      @NotNull public @NotNull InteractionDefinition definition()
      Returns the value of the definition record component.
      Specified by:
      definition in interface ErrorMessageFactory.ErrorContext
      Returns:
      the value of the definition record component

    • arguments

      @NotNull public @NotNull SequencedCollection<Object> arguments()
      Returns the value of the arguments record component.
      Returns:
      the value of the arguments record component