Package kboyle.oktane.core.module

Interface Precondition

All Known Implementing Classes:

AnyPrecondition, DiscordPrecondition, RequireBotOwner.BotOwnerPrecondition, RequireFailure.FailurePrecondition, RequireGuildOwner.GuildOwnerPrecondition, RequireHi.HiPrecondition, RequireHierarchy.HierarchyPrecondition, RequirePermission.PermissionPrecondition

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface Precondition

Method Summary

Modifier and Type	Method	Description
default PreconditionResult	failure(String reason, Object... args)
reactor.core.publisher.Mono<PreconditionResult>	run(CommandContext context, Command command)
default PreconditionResult	success()
default Set<AnnotatedElement>	supportedTargets()
default void	validate(AnnotatedElement annotatedElement)

Method Details

run

reactor.core.publisher.Mono<PreconditionResult> run(CommandContext context,
 Command command)

success

default PreconditionResult success()

failure

default PreconditionResult failure(String reason,
 Object... args)

supportedTargets

default Set<AnnotatedElement> supportedTargets()

Returns:

A set of AnnotatedElements that this precondition supports being added to.

validate

default void validate(AnnotatedElement annotatedElement)