001/*
002 * This file is part of Baritone.
003 *
004 * Baritone is free software: you can redistribute it and/or modify
005 * it under the terms of the GNU Lesser General Public License as published by
006 * the Free Software Foundation, either version 3 of the License, or
007 * (at your option) any later version.
008 *
009 * Baritone is distributed in the hope that it will be useful,
010 * but WITHOUT ANY WARRANTY; without even the implied warranty of
011 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
012 * GNU Lesser General Public License for more details.
013 *
014 * You should have received a copy of the GNU Lesser General Public License
015 * along with Baritone.  If not, see <https://www.gnu.org/licenses/>.
016 */
017
018package baritone.api.command.argparser;
019
020import baritone.api.command.argument.ICommandArgument;
021
022public interface IArgParser<T> {
023
024    /**
025     * @return the class of this parser.
026     */
027    Class<T> getTarget();
028
029    /**
030     * A stateless argument parser is just that. It takes a {@link ICommandArgument} and outputs its type.
031     */
032    interface Stateless<T> extends IArgParser<T> {
033
034        /**
035         * @param arg The argument to parse.
036         * @return What it was parsed into.
037         * @throws RuntimeException if you want the parsing to fail. The exception will be caught and turned into an
038         *                          appropriate error.
039         */
040        T parseArg(ICommandArgument arg) throws Exception;
041    }
042
043    /**
044     * A stated argument parser is similar to a stateless one. It also takes a {@link ICommandArgument}, but it also
045     * takes a second argument that can be any type, referred to as the state.
046     */
047    interface Stated<T, S> extends IArgParser<T> {
048
049        Class<S> getStateType();
050
051        /**
052         * @param arg   The argument to parse.
053         * @param state Can be anything.
054         * @return What it was parsed into.
055         * @throws RuntimeException if you want the parsing to fail. The exception will be caught and turned into an
056         *                          appropriate error.
057         */
058        T parseArg(ICommandArgument arg, S state) throws Exception;
059    }
060}