All Downloads are FREE. Search and download functionalities are using the official Maven repository.
  • Log In
  • Register

    • com.freya02.botcommands.api.commands.prefixed.CommandEvent Maven / Gradle / Ivy

    package com.freya02.botcommands.api.commands.prefixed;

import com.freya02.botcommands.api.commands.prefixed.exceptions.BadIdException;
import com.freya02.botcommands.api.commands.prefixed.exceptions.NoIdException;
import com.freya02.botcommands.internal.BContextImpl;
import com.freya02.botcommands.internal.commands.prefixed.BaseCommandEventImpl;
import net.dv8tion.jda.api.entities.IMentionable;
import net.dv8tion.jda.api.entities.Role;
import net.dv8tion.jda.api.entities.User;
import net.dv8tion.jda.api.entities.channel.concrete.TextChannel;
import net.dv8tion.jda.api.events.message.MessageReceivedEvent;
import org.jetbrains.annotations.NotNull;

import java.util.List;
import java.util.NoSuchElementException;

/**
 * Text command event containing all the information about the triggered command.
 *
 * 
    Arguments are tokenized and resolved into entities if possible
 *
 * 
    This is only used as a command fallback
 *
 * @see BaseCommandEvent
 */
public abstract class CommandEvent extends BaseCommandEventImpl {
	public CommandEvent(BContextImpl context, MessageReceivedEvent event, String args) {
		super(context, event, args);
	}

	/**
	 * Returns the resolved arguments of the command event, these can be a {@linkplain User}, {@linkplain Role}, {@linkplain TextChannel} or a {@linkplain String}
	 *
	 * @return List of arguments
	 */
	public abstract List getArguments();

	/**
	 * Checks if the next argument exists and is of type T, returns true if so
	 *
	 * @param clazz Class of the requested type
	 * @param    Type of the requested argument
	 * @return true if the argument exists, false if not
	 */
	public abstract  boolean hasNext(Class clazz);

	public abstract  T peekArgument(Class clazz);

	/**
	 * Returns the next argument if it is of type T
	 *
	 * @param clazz Class of the requested type
	 * @param    Type of the requested argument
	 * @return The argument of type T if it exists
	 * @throws NoSuchElementException In case there is no more arguments to be read
	 */
	@NotNull
	public abstract  T nextArgument(Class clazz);

	/**
	 * Returns the next IMentionable
	 *
	 * @param classes Class(es) of the requested type
	 * @param      Type of the requested argument
	 * @return The argument of type T, extending IMentionable, if it exists
	 * @throws BadIdException         In case the ID is not a valid snowflake, or does not refer to a known IMentionable
	 * @throws NoIdException          In case there is no ID / IMentionable in the message
	 * @throws NoSuchElementException In case there is no more arguments to be read, or the type isn't the same
	 */
	@NotNull
	public abstract  T resolveNext(Class... classes) throws NoIdException, BadIdException;
}
    
    
    
    

    




    
    
    © 2015 - 2025 Weber Informatics LLC | Privacy Policy