net.lenni0451.commandlib.utils.interfaces.CompletionsProvider Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of CommandLib Show documentation

A command lib with a simple and powerful API

The newest version!

package net.lenni0451.commandlib.utils.interfaces;

import net.lenni0451.commandlib.contexts.ExecutionContext;
import net.lenni0451.commandlib.utils.StringReader;

import java.util.Set;

/**
 * A functional interface to allow supplying custom completions.
 *
 * @param  The type of the executor
 */
@FunctionalInterface
public interface CompletionsProvider {

    /**
     * Provide custom completions.
     *
     * @param completions      The set of completions
     * @param executionContext The execution context
     * @param stringReader     The string reader
     */
    void provide(final Set completions, final ExecutionContext executionContext, final StringReader stringReader);

}