com.atlassian.bitbucket.hook.repository

Enum StandardRepositoryHookTrigger

java.lang.Object

java.lang.Enum<StandardRepositoryHookTrigger>

com.atlassian.bitbucket.hook.repository.StandardRepositoryHookTrigger

All Implemented Interfaces:

RepositoryHookTrigger, Serializable, Comparable<StandardRepositoryHookTrigger>

public enum StandardRepositoryHookTrigger
extends Enum<StandardRepositoryHookTrigger>
implements RepositoryHookTrigger

Built-in trigger types for repository-hook RepositoryHookRequests.

Since:

5.0

Enum Constant Summary

Enum Constants

Enum Constant and Description
BRANCH_CREATE
BRANCH_DELETE
FILE_EDIT
MERGE Invoked when ScmExtendedCommandFactory.merge(MergeCommandParameters) is called.
PULL_REQUEST_MERGE
REPO_PUSH
TAG_CREATE
TAG_DELETE
UNKNOWN An unclassified / not recognized trigger

Method Summary

Modifier and Type	Method and Description
static Optional<StandardRepositoryHookTrigger>	fromId(String id)
String	getId()
boolean	isAbortOnFirstVeto()
static StandardRepositoryHookTrigger	valueOf(String name) Returns the enum constant of this type with the specified name.
static StandardRepositoryHookTrigger[]	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

BRANCH_CREATE

public static final StandardRepositoryHookTrigger BRANCH_CREATE

See Also:

BranchCreationHookRequest

BRANCH_DELETE

public static final StandardRepositoryHookTrigger BRANCH_DELETE

See Also:

BranchDeletionHookRequest

FILE_EDIT

public static final StandardRepositoryHookTrigger FILE_EDIT

See Also:

FileEditHookRequest

MERGE

public static final StandardRepositoryHookTrigger MERGE

Invoked when ScmExtendedCommandFactory.merge(MergeCommandParameters) is called. Note that this is a low-level SCM operation and should not generally be intercepted.

See Also:

MergeHookRequest

PULL_REQUEST_MERGE

public static final StandardRepositoryHookTrigger PULL_REQUEST_MERGE

See Also:

PullRequestMergeHookRequest

REPO_PUSH

public static final StandardRepositoryHookTrigger REPO_PUSH

See Also:

RepositoryPushHookRequest

TAG_CREATE

public static final StandardRepositoryHookTrigger TAG_CREATE

See Also:

TagCreationHookRequest

TAG_DELETE

public static final StandardRepositoryHookTrigger TAG_DELETE

See Also:

TagDeletionHookRequest

UNKNOWN

public static final StandardRepositoryHookTrigger UNKNOWN

An unclassified / not recognized trigger

Method Detail

values

public static StandardRepositoryHookTrigger[] 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 (StandardRepositoryHookTrigger c : StandardRepositoryHookTrigger.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static StandardRepositoryHookTrigger 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

fromId

@Nonnull
public static Optional<StandardRepositoryHookTrigger> fromId(@Nullable
                                                                      String id)

getId

@Nonnull
public String getId()

Specified by:

getId in interface RepositoryHookTrigger

Returns:

the trigger identifier

isAbortOnFirstVeto

public boolean isAbortOnFirstVeto()

Specified by:

isAbortOnFirstVeto in interface RepositoryHookTrigger

Returns:

whether a RepositoryHookService.preUpdate(RepositoryHookRequest) invocation should stop calling other repository-hook modules after the first veto. Return false if all hooks need to be called even after one hook vetoes the request.