Class 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:
  • Field Details

    • serialVersionUID

      private static final long serialVersionUID
      See Also:
    • hookName

      private final String hookName
      The hook that caused this exception.
    • returnCode

      private final int returnCode
      The process result.
    • hookStdErr

      private final String hookStdErr
      The stderr output of the hook.
  • Constructor Details

    • 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 Details

    • 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