Module org.eclipse.jgit

Package org.eclipse.jgit.hooks

Class PreCommitHook

java.lang.Object

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

org.eclipse.jgit.hooks.PreCommitHook

All Implemented Interfaces:

Callable<Void>

public class PreCommitHook
extends GitHook<Void>

The pre-commit hook implementation. This hook is run before the commit and can reject the commit.

Since:

4.0

Field Summary

Fields

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
Void	call()
String	getHookName()	Get name of the hook

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

doRun, getErrorStream, getOutputStream, getParameters, getRepository, getStdinArgs, handleError, 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 pre-commit hook name.

See Also:

Constant Field Values

Constructor Detail

PreCommitHook

protected PreCommitHook(Repository repo,
                        PrintStream outputStream)

Constructor for PreCommitHook

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.

PreCommitHook

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

Constructor for PreCommitHook

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.