Package 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	Description
AbortedByHookException(String hookStdErr, String hookName, int returnCode)	Constructor for AbortedByHookException

Method Summary

Modifier and Type	Method	Description
String	getHookName()	Get hook name
String	getHookStdErr()	Get the stderr output of the hook.
int	getReturnCode()	Get return code

Methods inherited from class java.lang.Throwable

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

AbortedByHookException

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

Constructor for AbortedByHookException

Parameters:

hookStdErr - The error details from the stderr output of the hook

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

Get hook name

Returns:

the type of the hook that interrupted the git command.

getReturnCode

public int getReturnCode()

Get return code

Returns:

the hook process result.

getHookStdErr

public String getHookStdErr()

Get the stderr output of the hook.

Returns:

A string containing the complete stderr output of the hook.

Since:

5.6