org.eclipse.jgit.hooks

Class PreCommitHook

java.lang.Object

org.eclipse.jgit.hooks.PreCommitHook

All Implemented Interfaces:

Callable<Void>

public class PreCommitHook
extends Object

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 and Description
static String	NAME The pre-commit hook name.
protected PrintStream	outputStream The output stream to be used by the hook.

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
Void	call() Run the hook.
protected void	doRun() Runs the hook, without performing any validity checks.
String	getHookName()
protected PrintStream	getOutputStream()
protected String[]	getParameters() Override this method when needed to provide relevant parameters to the underlying hook script.
protected Repository	getRepository()
protected String	getStdinArgs() Override to provide relevant arguments via stdin to the underlying hook script.

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

outputStream

protected final PrintStream outputStream

The output stream to be used by the hook.

Constructor Detail

PreCommitHook

protected PreCommitHook(Repository repo,
             PrintStream outputStream)

Parameters:

repo - The repository

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

Method Detail

call

public Void call()
          throws IOException,
                 AbortedByHookException

Run the hook.

Specified by:

call in interface Callable<Void>

Throws:

IOException - if IO goes wrong.

AbortedByHookException - If the hook has been run and a returned an exit code different from zero.

getHookName

public String getHookName()

Returns:

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

getRepository

protected Repository getRepository()

Returns:

The repository.

getParameters

protected String[] getParameters()

Override this method when needed to provide relevant parameters to the underlying hook script. The default implementation returns an empty array.

Returns:

The parameters the hook receives.

getStdinArgs

protected String getStdinArgs()

Override to provide relevant arguments via stdin to the underlying hook script. The default implementation returns null.

Returns:

The parameters the hook receives.

getOutputStream

protected PrintStream getOutputStream()

Returns:

The output stream the hook must use. Never null, System.out is returned by default.

doRun

protected void doRun()
              throws AbortedByHookException

Runs the hook, without performing any validity checks.

Throws:

AbortedByHookException - If the underlying hook script exited with non-zero.