org.eclipse.jgit.hooks

Class CommitMsgHook

java.lang.Object

org.eclipse.jgit.hooks.CommitMsgHook

All Implemented Interfaces:

Callable<String>

public class CommitMsgHook
extends Object

The commit-msg hook implementation. This hook is run before the commit and can reject the commit. It passes one argument to the hook script, which is the path to the COMMIT_MSG file, relative to the repository workTree.

Since:

4.0

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAME Constant indicating the name of the commit-smg hook.
protected PrintStream	outputStream The output stream to be used by the hook.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
String	call()
protected void	doRun() Runs the hook, without performing any validity checks.
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.
CommitMsgHook	setCommitMessage(String commitMessage) It is mandatory to call this method with a non-null value before actually calling the hook.

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

Constant indicating the name of the commit-smg hook.

See Also:

Constant Field Values

outputStream

protected final PrintStream outputStream

The output stream to be used by the hook.

Constructor Detail

CommitMsgHook

protected CommitMsgHook(Repository repo,
                        PrintStream outputStream)

Constructor for CommitMsgHook

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 String call()
            throws IOException,
                   AbortedByHookException

Run the hook.

Specified by:

call in interface Callable<String>

Throws:

IOException

AbortedByHookException

getHookName

public String getHookName()

Get name of the hook

Returns:

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

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. This hook receives one parameter, which is the path to the file holding the current commit-msg, relative to the repository's work tree.

Returns:

The parameters the hook receives.

setCommitMessage

public CommitMsgHook setCommitMessage(String commitMessage)

It is mandatory to call this method with a non-null value before actually calling the hook.

Parameters:

commitMessage - The commit message before the hook has run.

Returns:

this for convenience.

getRepository

protected Repository getRepository()

Get the repository

Returns:

The repository.

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.

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