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

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

import com.freya02.botcommands.api.DefaultMessages;
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.interactions.DiscordLocale;
import org.jetbrains.annotations.NotNull;

/**
 * This interface serves as a supplier for {@link DefaultMessages} instances, given a {@link DiscordLocale}.
 *
 * 
 * Usage: Register your instance as a service with {@link BService}, and a {@link ServiceType} of {@link DefaultMessagesSupplier}.
 *
 * @see InterfacedService
 */
@InterfacedService(acceptMultiple = false)
public interface DefaultMessagesSupplier {
    @NotNull
    DefaultMessages get(@NotNull DiscordLocale discordLocale);
}