org.incendo.cloud.brigadier.argument.BrigadierMappings Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of cloud-brigadier Show documentation

Integrations between Minecraft and Cloud Command Framework

There is a newer version: 2.0.0-beta.10

//
// MIT License
//
// Copyright (c) 2024 Incendo
//
// 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.incendo.cloud.brigadier.argument;

import org.apiguardian.api.API;
import org.checkerframework.checker.nullness.qual.NonNull;
import org.checkerframework.checker.nullness.qual.Nullable;
import org.incendo.cloud.parser.ArgumentParser;

@API(status = API.Status.INTERNAL, since = "2.0.0")
public interface BrigadierMappings {

    /**
     * Returns a new instance of the default implementation.
     *
     * @param  cloud command sender type
     * @param  brigadier command source type
     * @return the mapping instance
     */
    static  @NonNull BrigadierMappings create() {
        return new BrigadierMappingsImpl<>();
    }

    /**
     * Returns the mapper for the given {@code parserType}.
     *
     * @param         the type produced by the parser
     * @param         the parser type
     * @param parserType the parser type
     * @return the mapping, or {@code null}
     */
    > @Nullable BrigadierMapping mapping(@NonNull Class parserType);

    /**
     * Registers the {@code mapping} for the given {@code parserType}.
     *
     * @param         the type produced by the parser
     * @param         the parser type
     * @param parserType the parser type
     * @param mapping    the mapping
     */
    default > void registerMapping(
            @NonNull Class parserType,
            @NonNull BrigadierMapping mapping
    ) {
        this.registerMappingUnsafe(parserType, mapping);
    }

    /**
     * Registers the {@code mapping} for the given {@code parserType}.
     *
     * @param         the parser type
     * @param parserType the parser type
     * @param mapping    the mapping
     */
    > void registerMappingUnsafe(
            @NonNull Class parserType,
            @NonNull BrigadierMapping mapping
    );
}