Package org.mockbukkit.mockbukkit.command

Class CommandResult

java.lang.Object
org.mockbukkit.mockbukkit.command.CommandResult
public class CommandResult extends Object
Represents the result of a command invocation.

  • Constructor Details

    • CommandResult

      @Internal public CommandResult(boolean success, @NotNull @NotNull MessageTarget sender)
      Constructs a new CommandResult with the provided parameters.
      Parameters:
      success - Whether the command succeeded (returned true).
      sender - The message target who executed the command.

  • Method Details

    • hasSucceeded

      public boolean hasSucceeded()
      Check if the command executed successfully.
      Returns:
      true if the command executed successfully, false if a problem occurred.

    • assertSucceeded

      @Deprecated(forRemoval=true) public void assertSucceeded()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Asserts if the returned code of the executed command is not true.

    • assertFailed

      @Deprecated(forRemoval=true) public void assertFailed()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Asserts if the returned code of the executed command is not false.

    • assertResponse

      @Deprecated(forRemoval=true) public void assertResponse(String message)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Assets if the given message was not the next message send to the command sender.
      Parameters:
      message - The message to check for.
      See Also:

    • assertResponse

      @Deprecated(forRemoval=true) public void assertResponse(@NotNull @NotNull String format, Object... objects)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Asserts if a given formatted message was not the next message sent to the command sender.
      Parameters:
      format - The formatted message to check for.
      objects - The objects to place into the formatted message.
      See Also:

    • assertNoResponse

      @Deprecated(forRemoval=true) public void assertNoResponse()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Asserts if more messages have been sent to the command sender.
      See Also:

    • getSender

      @NotNull public @NotNull MessageTarget getSender()
      Returns:
      The sender of this command