001//
002// MIT License
003//
004// Copyright (c) 2021 Alexander Söderberg & Contributors
005//
006// Permission is hereby granted, free of charge, to any person obtaining a copy
007// of this software and associated documentation files (the "Software"), to deal
008// in the Software without restriction, including without limitation the rights
009// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
010// copies of the Software, and to permit persons to whom the Software is
011// furnished to do so, subject to the following conditions:
012//
013// The above copyright notice and this permission notice shall be included in all
014// copies or substantial portions of the Software.
015//
016// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
017// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
018// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
019// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
020// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
021// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
022// SOFTWARE.
023//
024package cloud.commandframework.exceptions;
025
026import cloud.commandframework.context.CommandContext;
027import org.checkerframework.checker.nullness.qual.NonNull;
028import org.checkerframework.checker.nullness.qual.Nullable;
029
030/**
031 * Exception thrown when there is an exception during execution of a command handler
032 *
033 * @since 1.2.0
034 */
035public class CommandExecutionException extends IllegalArgumentException {
036
037    private static final long serialVersionUID = -4785446899438294661L;
038    private final CommandContext<?> commandContext;
039
040    /**
041     * Exception thrown when there is an exception during execution of a command handler
042     *
043     * @param cause Exception thrown during the execution of a command handler
044     */
045    public CommandExecutionException(final @NonNull Throwable cause) {
046        this(cause, null);
047    }
048
049    /**
050     * Exception thrown when there is an exception during execution of a command handler
051     *
052     * @param cause Exception thrown during the execution of a command handler
053     * @param commandContext Command context
054     * @since 1.4.0
055     */
056    public CommandExecutionException(final @NonNull Throwable cause, final @Nullable CommandContext<?> commandContext) {
057        super(cause);
058        this.commandContext = commandContext;
059    }
060
061    /**
062     * Get the CommandContext which led to this exception
063     *
064     * @return Command
065     * @since 1.4.0
066     */
067    public @Nullable CommandContext<?> getCommandContext() {
068        return this.commandContext;
069    }
070
071}