ch.vorburger.minecraft.utils.CommandExceptions Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of api Show documentation
OSGi-based Minecraft Server plugins
The newest version!
/**
 * ch.vorburger.minecraft.osgi
 *
 * Copyright (C) 2016 - 2017 Michael Vorburger.ch 
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published
 * by the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see .
 */
package ch.vorburger.minecraft.utils;

import java.util.concurrent.Callable;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.spongepowered.api.command.CommandException;

/**
 * Utilities for {@link CommandException}.
 *
 * @author Michael Vorburger.ch
 */
public final class CommandExceptions {

    private static final Logger LOG = LoggerFactory.getLogger(CommandExceptions.class);

    private CommandExceptions() { }

    /**
     * Invoke 'callable' and return its value,
     * or rethrow any Exception from it wrapped in a CommandException,
     * with description.
     *
     * @param description a humand-readable description of the Callable (used in the CommandException)
     * @param callable the code to invoke
     * @return the value returned by the callable
     * @throws CommandException in case the callable failed with an Exception
     */
    public static  T getOrThrow(String description, Callable callable) throws CommandException {
        try {
            return callable.call();
        } catch (Exception cause) {
            // TODO see isDeveloper() idea in Texts.fromThrowable
            throw new CommandException(Texts.fromThrowable(description, cause), cause, true);
        }
    }

    public static void doOrThrow(String description, RunnableWithException runnable) throws CommandException {
        try {
            runnable.run();
        } catch (Exception cause) {
        	// TODO once the cause is properly throw to the user incl. stack trace, this log is probably redundant; then remove?
            LOG.error("doOrThrow()", cause);
            // TODO see isDeveloper() idea in Texts.fromThrowable
            throw new CommandException(Texts.fromThrowable(description, cause), cause, true);
        }
    }

    public static CommandException create(String message) {
        return new CommandException(Texts.inRed(message));
    }

    @FunctionalInterface
    public static interface RunnableWithException {
        void run() throws Exception;
    }

}