com.oroarmor.json.brigadier.ArgumentParsers Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of json-to-brigadier Show documentation
This is a library that converts JSON to brigadier arguments.
There is a newer version: 1.3.1
/*
 * MIT License
 *
 * Copyright (c) 2021 OroArmor (Eli Orona)
 *
 * 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 com.oroarmor.json.brigadier;

import java.util.HashMap;
import java.util.Map;

import com.google.gson.JsonObject;
import com.mojang.brigadier.builder.ArgumentBuilder;
import com.oroarmor.json.brigadier.parsers.*;

/**
 * The different argument parsers for the different argument types that brigadier supports.
 * More parsers can be added with {@link ArgumentParsers#register(String, ArgumentParser)}
 */
public class ArgumentParsers {
    private static final Map PARSERS = new HashMap<>();

    static {
        register("brigadier:literal", LiteralArgumentParser::parse);
        register("brigadier:integer", IntegerArgumentParser::parse);
        register("brigadier:boolean", BooleanArgumentParser::parse);
        register("brigadier:double", DoubleArgumentParser::parse);
        register("brigadier:float", FloatArgumentParser::parse);
        register("brigadier:string", StringArgumentParser::parse);
        register("brigadier:long", LongArgumentParser::parse);
    }

    /**
     * Register a new parser type
     *
     * @param type   The string for the parser type. Should follow {@code application:argument}.
     *               i.e. {@code brigadier:integer} for {@link com.mojang.brigadier.arguments.IntegerArgumentType}
     * @param parser The parser for the type
     */
    public static void register(String type, ArgumentParser parser) {
        if (PARSERS.containsKey(type)) {
            throw new IllegalArgumentException(type + " already exists");
        }
        PARSERS.put(type, parser);
    }

    /**
     * Gets the parser from the type
     *
     * @param type The type for the parser
     * @return The parser
     */
    public static ArgumentParser get(String type) {
        return PARSERS.get(type);
    }

    /**
     * A Functional Interface that parses arguments
     */
    @FunctionalInterface
    public interface ArgumentParser {
        /**
         * Parses a JsonObject into a command. Do not parse for children in this method
         *
         * @param commandObject The JsonObject for the command
         * @param         The type of the command context
         * @param         The {@link ArgumentBuilder} self type
         * @return An {@link ArgumentBuilder} representing this command node only
         */
        > ArgumentBuilder parse(JsonObject commandObject);
    }
}