Package com.atlassian.bitbucket.scm

Class CommandUsageException

java.lang.Object

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

All Implemented Interfaces:

Serializable

public class CommandUsageException
extends CommandFailedException

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();

     builder.command("command").argument("a").argument("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.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
CommandUsageException(KeyedMessage message, String command, String usage)

Method Summary

Modifier and Type	Method	Description
String	getCommand()
String	getUsage()

Methods inherited from class com.atlassian.bitbucket.ServiceException

getKeyedMessage, getLocalizedMessage, getMessageKey

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

CommandUsageException

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

Method Details

getCommand

@Nonnull
public String getCommand()

Returns:

the command as it was executed

getUsage

@Nonnull
public String getUsage()

Returns:

the usage message