Class Helpers

java.lang.Object

com.github.kaktushose.jda.commands.internal.Helpers

@Internal
public final class Helpers
extends Object

Collection of helper methods that are used inside the framework.

Constructor Summary

Constructors

Constructor	Description
Helpers()

Method Summary

Modifier and Type	Method	Description
static void	checkDetached(IDetachableEntity entity, Class<?> origin)
static void	checkParameterType(MethodDescription method, int index, Class<?> type)	Checks if the given parameter is present at the Method at the given index.
static void	checkSignature(MethodDescription method, SequencedCollection<Class<?>> methodSignature)
static void	checkSignatureUserContext(MethodDescription method)
static CommandDefinition.CommandConfig	commandConfig(MethodBuildContext context)	The CommandDefinition.CommandConfig that should be used when registering commands.
static ErrorMessageFactory.ErrorContext	errorContext(GenericInteractionCreateEvent event, InteractionDefinition definition)
static String	humanReadableType(OptionMapping optionMapping)	Gets the human-readable representation of an OptionMapping.
static Set<String>	permissions(MethodBuildContext context)	Extracts the permissions from a MethodBuildContext.
static InteractionDefinition.ReplyConfig	replyConfig(Invokable definition, InteractionDefinition.ReplyConfig fallback)	The InteractionDefinition.ReplyConfig that should be used when sending replies.

Methods inherited from class java.lang.Object

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

Constructor Details

Helpers

public Helpers()

Method Details

humanReadableType

public static String humanReadableType(OptionMapping optionMapping)

Gets the human-readable representation of an OptionMapping.

Parameters:

optionMapping - the OptionMapping to return the human-readable representation for

Returns:

the human-readable representation

permissions

public static Set<String> permissions(MethodBuildContext context)

Extracts the permissions from a MethodBuildContext. This combines the permissions of the method and the class.

Parameters:

context - the MethodBuildContext to extract the permissions from

Returns:

a possibly-empty set of all permissions

checkParameterType

public static void checkParameterType(MethodDescription method,
 int index,
 Class<?> type)

Checks if the given parameter is present at the Method at the given index.

Parameters:

method - the Method to check

index - the index the parameter is expected to be at

type - the type of the parameter

checkSignature

public static void checkSignature(MethodDescription method,
 SequencedCollection<Class<?>> methodSignature)

checkSignatureUserContext

public static void checkSignatureUserContext(MethodDescription method)

checkDetached

public static void checkDetached(IDetachableEntity entity,
 Class<?> origin)

replyConfig

public static InteractionDefinition.ReplyConfig replyConfig(Invokable definition,
 InteractionDefinition.ReplyConfig fallback)

The InteractionDefinition.ReplyConfig that should be used when sending replies.

Parameters:

definition - the interaction definition to build the InteractionDefinition.ReplyConfig from

fallback - the InteractionDefinition.ReplyConfig to use as a fallback

Implementation Note:

This will first attempt to use the ReplyConfig annotation of the method and then of the class. If neither is present will fall back to the global InteractionDefinition.ReplyConfig provided by JDACBuilder.

commandConfig

public static CommandDefinition.CommandConfig commandConfig(MethodBuildContext context)

The CommandDefinition.CommandConfig that should be used when registering commands.

Parameters:

context - the MethodBuildContext to build the CommandDefinition.CommandConfig from

Implementation Note:

This will first attempt to use the CommandConfig annotation of the method and then of the class. If neither is present will fall back to the global CommandDefinition.CommandConfig provided by JDACBuilder.

errorContext

public static ErrorMessageFactory.ErrorContext errorContext(GenericInteractionCreateEvent event,
 InteractionDefinition definition)