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
protected PrintStream	errorStream The error stream to be used by the hook.
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) Constructor for PreCommitHook
protected	PreCommitHook(Repository repo, PrintStream outputStream, PrintStream errorStream) Constructor for PreCommitHook

Method Summary

Modifier and Type	Method and Description
Void	call()
protected void	doRun() Runs the hook, without performing any validity checks.
protected PrintStream	getErrorStream() Get error stream
String	getHookName() Get name of the hook
protected PrintStream	getOutputStream() Get output stream
protected String[]	getParameters() Override this method when needed to provide relevant parameters to the underlying hook script.
protected Repository	getRepository() Get the repository
protected String	getStdinArgs() Override to provide relevant arguments via stdin to the underlying hook script.
boolean	isNativeHookPresent() Check whether a 'native' (i.e.

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.

errorStream

protected final PrintStream errorStream

The error stream to be used by the hook.

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>

Throws:

IOException

AbortedByHookException

getHookName

public String getHookName()

Get name of the hook

Returns:

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

getRepository

protected Repository getRepository()

Get the repository

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

Get output stream

Returns:

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

getErrorStream

protected PrintStream getErrorStream()

Get error stream

Returns:

The error stream the hook must use. Never null, System.err 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.

isNativeHookPresent

public boolean isNativeHookPresent()

Check whether a 'native' (i.e. script) hook is installed in the repository.

Returns:

whether a native hook script is installed in the repository.

Since:

4.11