command.CommandExecutionException.kt Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of mirai-console Show documentation

Mirai Console Backend

There is a newer version: 2.16.0

/*
 * Copyright 2019-2020 Mamoe Technologies and contributors.
 *
 * 此源代码的使用受 GNU AFFERO GENERAL PUBLIC LICENSE version 3 许可证的约束, 可以在以下链接找到该许可证.
 * Use of this source code is governed by the GNU AFFERO GENERAL PUBLIC LICENSE version 3 license that can be found through the following link.
 *
 * https://github.com/mamoe/mirai/blob/master/LICENSE
 */

@file:Suppress("MemberVisibilityCanBePrivate")

package net.mamoe.mirai.console.command

/**
 * 在 [CommandManager.executeCommand] 中抛出异常时包装的异常.
 */
public class CommandExecutionException(
    /**
     * 执行者
     */
    public val sender: CommandSender,
    /**
     * 执行过程发生异常的指令
     */
    public val command: Command,
    /**
     * 匹配到的指令名
     */
    public val name: String,
    cause: Throwable,
) : RuntimeException(
    "Exception while executing command '${command.primaryName}'",
    cause
) {
    public override fun toString(): String =
        "CommandExecutionException(command=$command, name='$name')"
}