org.spongepowered.api.command.manager.CommandMapping 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.manager;

import org.spongepowered.api.command.registrar.CommandRegistrar;
import org.spongepowered.plugin.PluginContainer;

import java.util.Optional;
import java.util.Set;

/**
 * Provides information about a mapping between a command and its aliases.
 */
public interface CommandMapping {

    /**
     * Gets the primary alias that will be passed to the registered
     * {@link CommandRegistrar}. Note that this alias may not correspond to
     * an alias in {@link #allAliases()}, it is used as an identifier to
     * the underlying {@link CommandRegistrar}.
     *
     * @return The primary alias
     */
    String primaryAlias();

    /**
     * Gets an immutable list of all aliases.
     *
     * The returned list must contain at least one entry, of which one must
     * be the one returned by {@link #primaryAlias()}.
     *
     * There may be several versions of the same alias with different
     * casing, although generally implementations should ignore the casing
     * of aliases.
     *
     * @return A set of aliases
     */
    Set allAliases();

    /**
     * Gets the plugin that owns the command, if known.
     *
     * @return The plugin.
     */
    Optional plugin();

    /**
     * Gets the {@link CommandRegistrar} that registered this command.
     *
     * @return The {@link CommandRegistrar}
     */
    CommandRegistrar registrar();

}