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.exception;
019
020import baritone.api.command.ICommand;
021import baritone.api.command.argument.ICommandArgument;
022import java.util.List;
023import net.minecraft.ChatFormatting;
024
025import static baritone.api.utils.Helper.HELPER;
026
027/**
028 * The base for a Baritone Command Exception, checked or unchecked. Provides a
029 * {@link #handle(ICommand, List)} method that is used to provide useful output
030 * to the user for diagnosing issues that may have occurred during execution.
031 * <p>
032 * Anything implementing this interface should be assignable to {@link Exception}.
033 *
034 * @author Brady
035 * @since 9/20/2019
036 */
037public interface ICommandException {
038
039    /**
040     * @return The exception details
041     * @see Exception#getMessage()
042     */
043    String getMessage();
044
045    /**
046     * Called when this exception is thrown, to handle the exception.
047     *
048     * @param command The command that threw it.
049     * @param args    The arguments the command was called with.
050     */
051    default void handle(ICommand command, List<ICommandArgument> args) {
052        HELPER.logDirect(this.getMessage(), ChatFormatting.RED);
053    }
054}