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.datatypes;
019
020import baritone.api.command.exception.CommandException;
021
022import java.util.function.Supplier;
023
024/**
025 * An {@link IDatatype} which acts as a {@link Supplier}, in essence. The only difference
026 * is that it requires an {@link IDatatypeContext} to be provided due to the expectation that
027 * implementations of {@link IDatatype} are singletons.
028 */
029public interface IDatatypeFor<T> extends IDatatype {
030
031    /**
032     * Consumes the desired amount of arguments from the specified {@link IDatatypeContext}, and
033     * then returns the parsed value. This method will more than likely return a {@link IllegalArgumentException}
034     * if the expected input does not conform to a parseable value. As far as a {@link CommandException} being
035     * thrown is concerned, see the note below for specifics.
036     *
037     * @param ctx The context
038     * @return The parsed data-type
039     * @throws CommandException If there was an issue parsing using another type or arguments could not be polled.
040     * @see IDatatypeContext
041     */
042    T get(IDatatypeContext ctx) throws CommandException;
043}