Module org.eclipse.jgit

Package org.eclipse.jgit.hooks

Class PostCommitHook

java.lang.Object

org.eclipse.jgit.hooks.GitHook<Void>

org.eclipse.jgit.hooks.PostCommitHook

All Implemented Interfaces:

Callable<Void>

public class PostCommitHook
extends GitHook<Void>

The post-commit hook implementation. This hook is run after the commit was successfully executed.

Since:

4.5

Field Summary

Fields

Modifier and Type	Field	Description
static String	NAME	The post-commit hook name.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	PostCommitHook(Repository repo, PrintStream outputStream)	Constructor for PostCommitHook
protected	PostCommitHook(Repository repo, PrintStream outputStream, PrintStream errorStream)	Constructor for PostCommitHook

Method Summary

Modifier and Type	Method	Description
Void	call()
String	getHookName()	Get name of the hook
protected void	handleError(String message, ProcessResult result)	Overwrites the default implementation to never throw an AbortedByHookException, as the commit has already been done and the exit code of the post-commit hook has no effect.

Methods inherited from class org.eclipse.jgit.hooks.GitHook

doRun, getErrorStream, getOutputStream, getParameters, getRepository, getStdinArgs, isNativeHookPresent

Methods inherited from class java.lang.Object

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

Field Detail

NAME

public static final String NAME

The post-commit hook name.

See Also:

Constant Field Values

Constructor Detail

PostCommitHook

protected PostCommitHook(Repository repo,
                         PrintStream outputStream)

Constructor for PostCommitHook

This constructor will use the default error stream.

Parameters:

repo - The repository

outputStream - The output stream the hook must use. null is allowed, in which case the hook will use System.out.

PostCommitHook

protected PostCommitHook(Repository repo,
                         PrintStream outputStream,
                         PrintStream errorStream)

Constructor for PostCommitHook

Parameters:

repo - The repository

outputStream - The output stream the hook must use. null is allowed, in which case the hook will use System.out.

errorStream - The error stream the hook must use. null is allowed, in which case the hook will use System.err.

Since:

5.6

Method Detail

call

public Void call()
          throws IOException,
                 AbortedByHookException

Run the hook.

Specified by:

call in interface Callable<Void>

Specified by:

call in class GitHook<Void>

Throws:

IOException

AbortedByHookException

getHookName

public String getHookName()

Get name of the hook

Specified by:

getHookName in class GitHook<Void>

Returns:

The name of the hook, which must not be null.

handleError

protected void handleError(String message,
                           ProcessResult result)
                    throws AbortedByHookException

Overwrites the default implementation to never throw an AbortedByHookException, as the commit has already been done and the exit code of the post-commit hook has no effect.

Overrides:

handleError in class GitHook<Void>

Parameters:

message - error message

result - The process result of the hook

Throws:

AbortedByHookException - When the hook should be aborted