com.palantir.giraffe.command

Class CommandException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

com.palantir.giraffe.command.CommandException

All Implemented Interfaces:

Serializable

public class CommandException
extends RuntimeException

Runtime exception thrown when a command fails, usually by exiting with a non-zero exit status.

The message contains detailed information about the command that ran, the execution system that ran it, and the output of the command. This information is also available programmatically via getter methods.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CommandException(TerminatedCommand failed)

Method Summary

Modifier and Type	Method and Description
ImmutableList<String>	getArguments() Returns the arguments of the failed command.
String	getExecutable() Returns the failed command.
String	getMessage() Returns a description of the executed command and how it failed.
CommandResult	getResult() Returns the result of executing the command.
URI	getUri() Returns the URI of the system that executed the command.

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, 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 Detail

CommandException

public CommandException(TerminatedCommand failed)

Method Detail

getExecutable

public String getExecutable()

Returns the failed command.

getArguments

public ImmutableList<String> getArguments()

Returns the arguments of the failed command.

getUri

public URI getUri()

Returns the URI of the system that executed the command.

getResult

public CommandResult getResult()

Returns the result of executing the command.

getMessage

public String getMessage()

Returns a description of the executed command and how it failed.

The description spans multiple lines and includes the:

• Exit status
• Executable name or path
• Argument list, with each argument surrounded by double quotes
• Working directory, if not the default
• Environment, if not the default
• Execution system URI
• Contents of the output and error streams

Overrides:

getMessage in class Throwable

Returns:

a description of the failed command