com.freya02.botcommands.api.core.DefaultEmbedSupplier Maven / Gradle / Ivy

Go to download
package com.freya02.botcommands.api.core;

import com.freya02.botcommands.api.commands.prefixed.BaseCommandEvent;
import com.freya02.botcommands.api.core.service.annotations.BService;
import com.freya02.botcommands.api.core.service.annotations.InterfacedService;
import com.freya02.botcommands.api.core.service.annotations.ServiceType;
import net.dv8tion.jda.api.EmbedBuilder;
import org.jetbrains.annotations.NotNull;

/**
 * Interface for embeds requested by {@link BaseCommandEvent#getDefaultEmbed()}, aiming to reduce boilerplate.
 * 
This embed is also used in the default help command.
 *
 * 
 * Usage: Register your instance as a service with {@link BService}, and a {@link ServiceType} of {@link DefaultEmbedSupplier}.
 *
 * @see InterfacedService
 */
@InterfacedService(acceptMultiple = false)
public interface DefaultEmbedSupplier {
	class Default implements DefaultEmbedSupplier {
		@NotNull
		@Override
		public EmbedBuilder get() {
			return new EmbedBuilder();
		}
	}

	@NotNull
	EmbedBuilder get();
}