public class


extends CommandFailedException
   ↳ java.lang.Throwable
     ↳ java.lang.Exception
       ↳ java.lang.RuntimeException
         ↳ com.atlassian.bitbucket.ServiceException
           ↳ com.atlassian.bitbucket.scm.CommandException
             ↳ com.atlassian.bitbucket.scm.CommandFailedException
               ↳ com.atlassian.bitbucket.scm.CommandUsageException

Class Overview

A specialization of CommandFailedException thrown when a command fails because it is called incorrectly.

This exception is an indication of a developer error, not a user error. In practice, these exceptions should never occur during normal operation.

Developer note: When considering the command against the usage message, be aware that representing the command as a single String may conceal subtle usage issues. For example, when providing multiple arguments to a command builder via its argument(String), providing multiple arguments in a single call separated by spaces will result in the arguments not being received correctly by the command when it is executed but will produce the same String representation. For example, both of the following will produce the same String:

     builder.command("command").argument("a b").build(...).call();

However, the executed command will receive different arguments ("a b" and ["a", "b"], respectively). If the command arguments appear to be valid based on the usage message, double-check how they are provided.


Public Constructors
CommandUsageException(KeyedMessage message, String command, String usage)
Public Methods
@Nonnull String getCommand()
@Nonnull String getUsage()
Inherited Methods
From class com.atlassian.bitbucket.ServiceException
From class java.lang.Throwable
From class java.lang.Object

Public Constructors

public CommandUsageException (KeyedMessage message, String command, String usage)

Public Methods

@Nonnull public String getCommand ()

  • the command as it was executed

@Nonnull public String getUsage ()

  • the usage message