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 boolean	checkSignature(MethodDescription method, Collection<Class<?>> methodSignature)
static CommandDefinition.CommandConfig	commandConfig(MethodBuildContext context)	The CommandDefinition.CommandConfig that should be used when registering commands.
static @NotNull ErrorMessageFactory.ErrorContext	errorContext(@NotNull GenericInteractionCreateEvent event, @NotNull InteractionDefinition definition)
static boolean	isIncorrectParameterType(@NotNull MethodDescription method, int index, @NotNull Class<?> type)	Checks if the given parameter is present at the Method at the given index.
static @NotNull Set<String>	permissions(@NotNull MethodBuildContext context)	Extracts the permissions from a MethodBuildContext.
static InteractionDefinition.ReplyConfig	replyConfig(@NotNull Invokable definition, InteractionDefinition.ReplyConfig fallback)	The InteractionDefinition.ReplyConfig that should be used when sending replies.
static @NotNull Optional<GuildChannel>	resolveGuildChannel(@NotNull String raw, @NotNull GenericInteractionCreateEvent event)	Attempts to resolve a GuildChannel based on user input.
static @NotNull String	sanitizeMention(@NotNull String mention)	Sanitizes a String containing a raw mention.

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

sanitizeMention

@NotNull
public static @NotNull String sanitizeMention(@NotNull
 @NotNull String mention)

Sanitizes a String containing a raw mention. This will remove all markdown characters namely <, @, #, &, !, >. For instance: <@!393843637437464588> gets sanitized to 393843637437464588.

Parameters:

mention - the raw String to sanitize

Returns:

the sanitized String

resolveGuildChannel

@NotNull
public static @NotNull Optional<GuildChannel> resolveGuildChannel(@NotNull
 @NotNull String raw,
 @NotNull
 @NotNull GenericInteractionCreateEvent event)

Attempts to resolve a GuildChannel based on user input.

Parameters:

raw - the String the GuildChannel should be resolved from

event - the corresponding GenericInteractionCreateEvent

Returns:

an Optional holding the resolved GuildChannel or an empty Optional if the resolving failed

permissions

@NotNull
public static @NotNull Set<String> permissions(@NotNull
 @NotNull 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

isIncorrectParameterType

public static boolean isIncorrectParameterType(@NotNull
 @NotNull MethodDescription method,
 int index,
 @NotNull
 @NotNull 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

Returns:

true if the parameter is present

checkSignature

public static boolean checkSignature(MethodDescription method,
 Collection<Class<?>> methodSignature)

checkDetached

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

replyConfig

@NotNull
public static InteractionDefinition.ReplyConfig replyConfig(@NotNull
 @NotNull Invokable definition,
 @NotNull
 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

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