1 package dev.sympho.modular_commands.api.command.result;
2
3 import org.checkerframework.dataflow.qual.Pure;
4
5 /**
6 * The result from a command that fails to execute due to an internal error.
7 *
8 * <p>This is not the result for a command that fails due to user
9 * error. {@link CommandFailure} is used in that case.
10 *
11 * @version 1.0
12 * @since 1.0
13 */
14 public non-sealed interface CommandError extends CommandResult {
15
16 /**
17 * Retrieves the error message.
18 *
19 * @return The error message.
20 */
21 @Pure
22 String message();
23
24 }