org.spongepowered.api.command.CommandCompletion Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of spongeapi Show documentation
A plugin API for Minecraft: Java Edition
The newest version!
/*
 * This file is part of SpongeAPI, licensed under the MIT License (MIT).
 *
 * Copyright (c) SpongePowered 
 * Copyright (c) contributors
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
package org.spongepowered.api.command;

import net.kyori.adventure.text.Component;
import org.checkerframework.checker.nullness.qual.NonNull;
import org.checkerframework.checker.nullness.qual.Nullable;
import org.spongepowered.api.Sponge;

import java.util.Optional;

/**
 * A potential completion of a command argument.
 */
public interface CommandCompletion {

    /**
     * Creates a basic completion that only contains {@link String} that a given
     * input may be completed to.
     *
     * @param completion The potential completion
     * @return The {@link CommandCompletion} object
     */
    static CommandCompletion of(final @NonNull String completion) {
        return CommandCompletion.of(completion, null);
    }

    /**
     * Creates a completion that contains {@link String} that a given
     * input may be completed to, and an associated tooltip.
     *
     * @param completion The potential completion
     * @param tooltip The tooltip
     * @return The {@link CommandCompletion} object
     */
    static CommandCompletion of(final @NonNull String completion, final @Nullable Component tooltip) {
        return Sponge.game().factoryProvider().provide(Factory.class).completion(completion, tooltip);
    }

    /**
     * The potential completion that this object represents.
     *
     * @return The completion
     */
    String completion();

    /**
     * The tooltip that may be displayed by the client when hovering over this
     * completion.
     *
     * @return The tooltip, if any
     */
    Optional tooltip();

    /**
     * A factory for constructing {@link CommandCompletion}s
     */
    interface Factory {

        /**
         * Creates a {@link CommandCompletion}
         *
         * @param completion The completion
         * @param tooltip The {@link Component} to display, if any
         * @return A {@link CommandCompletion}
         */
        CommandCompletion completion(String completion, @Nullable Component tooltip);

    }

}