Package net.kautler.command.api.prefix.javacord

Class MentionPrefixTransformerJavacord

java.lang.Object

net.kautler.command.api.prefix.javacord.MentionPrefixTransformerJavacord

All Implemented Interfaces:

CommandContextTransformer<Message>

public abstract class MentionPrefixTransformerJavacord
extends Object
implements CommandContextTransformer<Message>

A base class for having a mention of the Javacord-based bot as command prefix. To use it, create a trivial subclass of this class and make it a discoverable CDI bean, for example by annotating it with @ApplicationScoped, and add the @InPhase qualifier with BEFORE_PREFIX_COMPUTATION as argument.

Nested Class Summary

Nested classes/interfaces inherited from interface net.kautler.command.api.CommandContextTransformer

CommandContextTransformer.InPhase, CommandContextTransformer.InPhases, CommandContextTransformer.Phase

Constructor Summary

Constructors

Constructor	Description
MentionPrefixTransformerJavacord()

Method Summary

Modifier and Type	Method	Description
String	toString()
<T extends Message> CommandContext<T>	transform(CommandContext<T> commandContext, CommandContextTransformer.Phase phase)	Transforms the given command context in the given phase.

Methods inherited from class java.lang.Object

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

Constructor Detail

MentionPrefixTransformerJavacord

public MentionPrefixTransformerJavacord()

Method Detail

transform

public <T extends Message> CommandContext<T> transform(CommandContext<T> commandContext,
                                                       CommandContextTransformer.Phase phase)

Description copied from interface: CommandContextTransformer

Transforms the given command context in the given phase. The fields of the given command context can be empty depending on the current phase. The fields that are set in the returned command context can cause future phases to be skipped if the according data is already computed in an earlier phase. The description of the single phases specifies which fields in the given command context should be set and which fields in the returned command context should be set and the respective effect that is caused by this. The returned value must not be null.

Specified by:

transform in interface CommandContextTransformer<Message>

Type Parameters:

T - the class of the messages for which this transformer is triggered

Parameters:

commandContext - the command context to be transformed, usually populated according to the phase description, but not necessarily

phase - the phase this transformer is currently called in

Returns:

the transformed command context

See Also:

CommandContextTransformer.Phase

toString

public String toString()

Overrides:

toString in class Object