org.eclipse.jgit.api.errors

Class AbortedByHookException

java.lang.Object

java.lang.Throwable

java.lang.Exception

org.eclipse.jgit.api.errors.GitAPIException

org.eclipse.jgit.api.errors.AbortedByHookException

All Implemented Interfaces:

Serializable

public class AbortedByHookException
extends GitAPIException

Exception thrown when a hook returns a process result with a value different from 0. It is up to the caller to decide whether this should block execution or not.

Since:

4.0

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AbortedByHookException(String message, String hookName, int returnCode)

Method Summary

Methods

Modifier and Type	Method and Description
String	getHookName()
String	getMessage()
int	getReturnCode()

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

AbortedByHookException

public AbortedByHookException(String message,
                      String hookName,
                      int returnCode)

Parameters:

message - The error details.

hookName - The name of the hook that interrupted the command, must not be null.

returnCode - The return code of the hook process that has been run.

Method Detail

getHookName

public String getHookName()

Returns:

the type of the hook that interrupted the git command.

getReturnCode

public int getReturnCode()

Returns:

the hook process result.

getMessage

public String getMessage()

Overrides:

getMessage in class Throwable