GitHookType (Git Build Hook Maven Plugin 3.4.1 API)

java.lang.Object
- java.lang.Enum<GitHookType>
- - com.rudikershaw.gitbuildhook.hook.type.GitHookType

All Implemented Interfaces:

Serializable, Comparable<GitHookType>
```
public enum GitHookType
extends Enum<GitHookType>
```
Enumerated types of Git hook.

Enum Constant Summary

Enum Constants
Enum Constant and Description
`APPLYPATCH_MSG` The apply patch message hook.
`COMMIT_MSG` Commit message hook.
`FSMONITOR_WATCHMAN` FS monitor watchman hook.
`P4_CHANGELIST` P4 changelist hook.
`P4_POST_CHANGELIST` P4 post changelist hook.
`P4_PRE_SUBMIT` P4 pre submit hook.
`P4_PREPARE_CHANGELIST` P4 prepare changelist hook.
`POST_APPLYPATCH` Post apply patch hook.
`POST_CHECKOUT` Post checkout hook.
`POST_COMMIT` Post commit hook.
`POST_INDEX_CHANGE` Post index change hook.
`POST_MERGE` The post merge hook.
`POST_RECEIVE` Post receive hook.
`POST_REWRITE` Post rewrite hook.
`POST_UPDATE` The post update hook.
`PRE_APPLYPATCH` The pre apply patch hook.
`PRE_AUTO_GC` Pre auto gc hook.
`PRE_COMMIT` Pre commit hook.
`PRE_MERGE_COMMIT` Pre merge commit hook.
`PRE_PUSH` Pre push hook.
`PRE_REBASE` Pre rebase hook.
`PRE_RECEIVE` Pre receive hook.
`PREPARE_COMMIT_MSG` Prepare commit message.
`PROC_RECEIVE` Proc receive hook.
`PUSH_TO_CHECKOUT` Push to checkout hook.
`REFERENCE_TRANSACTION` Reference transaction hook.
`SENDEMAIL_VALIDATE` Send email validate hook.
`UPDATE` The update hook.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getHookFileName()` Gets the pre-specified name of the file for hooks of this type.
`static boolean`	`isValidHookName(String filename)` Takes a string filename and returns true if, and only if, the string is a valid hook name.
`static GitHookType`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static GitHookType[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - PRE_COMMIT
```
public static final GitHookType PRE_COMMIT
```
    Pre commit hook.
  - PRE_MERGE_COMMIT
```
public static final GitHookType PRE_MERGE_COMMIT
```
    Pre merge commit hook.
  - PRE_PUSH
```
public static final GitHookType PRE_PUSH
```
    Pre push hook.
  - PRE_REBASE
```
public static final GitHookType PRE_REBASE
```
    Pre rebase hook.
  - COMMIT_MSG
```
public static final GitHookType COMMIT_MSG
```
    Commit message hook.
  - PREPARE_COMMIT_MSG
```
public static final GitHookType PREPARE_COMMIT_MSG
```
    Prepare commit message.
  - UPDATE
```
public static final GitHookType UPDATE
```
    The update hook.
  - POST_UPDATE
```
public static final GitHookType POST_UPDATE
```
    The post update hook.
  - APPLYPATCH_MSG
```
public static final GitHookType APPLYPATCH_MSG
```
    The apply patch message hook.
  - PRE_APPLYPATCH
```
public static final GitHookType PRE_APPLYPATCH
```
    The pre apply patch hook.
  - POST_MERGE
```
public static final GitHookType POST_MERGE
```
    The post merge hook.
  - POST_APPLYPATCH
```
public static final GitHookType POST_APPLYPATCH
```
    Post apply patch hook.
  - POST_COMMIT
```
public static final GitHookType POST_COMMIT
```
    Post commit hook.
  - POST_CHECKOUT
```
public static final GitHookType POST_CHECKOUT
```
    Post checkout hook.
  - PRE_RECEIVE
```
public static final GitHookType PRE_RECEIVE
```
    Pre receive hook.
  - PROC_RECEIVE
```
public static final GitHookType PROC_RECEIVE
```
    Proc receive hook.
  - POST_RECEIVE
```
public static final GitHookType POST_RECEIVE
```
    Post receive hook.
  - REFERENCE_TRANSACTION
```
public static final GitHookType REFERENCE_TRANSACTION
```
    Reference transaction hook.
  - PUSH_TO_CHECKOUT
```
public static final GitHookType PUSH_TO_CHECKOUT
```
    Push to checkout hook.
  - PRE_AUTO_GC
```
public static final GitHookType PRE_AUTO_GC
```
    Pre auto gc hook.
  - POST_REWRITE
```
public static final GitHookType POST_REWRITE
```
    Post rewrite hook.
  - SENDEMAIL_VALIDATE
```
public static final GitHookType SENDEMAIL_VALIDATE
```
    Send email validate hook.
  - FSMONITOR_WATCHMAN
```
public static final GitHookType FSMONITOR_WATCHMAN
```
    FS monitor watchman hook.
  - P4_CHANGELIST
```
public static final GitHookType P4_CHANGELIST
```
    P4 changelist hook.
  - P4_PREPARE_CHANGELIST
```
public static final GitHookType P4_PREPARE_CHANGELIST
```
    P4 prepare changelist hook.
  - P4_POST_CHANGELIST
```
public static final GitHookType P4_POST_CHANGELIST
```
    P4 post changelist hook.
  - P4_PRE_SUBMIT
```
public static final GitHookType P4_PRE_SUBMIT
```
    P4 pre submit hook.
  - POST_INDEX_CHANGE
```
public static final GitHookType POST_INDEX_CHANGE
```
    Post index change hook.
- Method Detail
  - values
```
public static GitHookType[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (GitHookType c : GitHookType.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static GitHookType valueOf(String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null
  - getHookFileName
```
public String getHookFileName()
```
    Gets the pre-specified name of the file for hooks of this type.
    
    Returns:
    
    the hook file name.
  - isValidHookName
```
public static boolean isValidHookName(String filename)
```
    Takes a string filename and returns true if, and only if, the string is a valid hook name.
    
    Parameters:
    
    filename - the filename to check.
    
    Returns:
    
    true if the provided string is a valid hook name, otherwise false.

Enum GitHookType

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

PRE_COMMIT

PRE_MERGE_COMMIT

PRE_PUSH

PRE_REBASE

COMMIT_MSG

PREPARE_COMMIT_MSG

UPDATE

POST_UPDATE

APPLYPATCH_MSG

PRE_APPLYPATCH

POST_MERGE

POST_APPLYPATCH

POST_COMMIT

POST_CHECKOUT

PRE_RECEIVE

PROC_RECEIVE

POST_RECEIVE

REFERENCE_TRANSACTION

PUSH_TO_CHECKOUT

PRE_AUTO_GC

POST_REWRITE

SENDEMAIL_VALIDATE

FSMONITOR_WATCHMAN

P4_CHANGELIST

P4_PREPARE_CHANGELIST

P4_POST_CHANGELIST

P4_PRE_SUBMIT

POST_INDEX_CHANGE

Method Detail

values

valueOf

getHookFileName

isValidHookName