com.atlassian.bitbucket.hook.repository

Class RepositoryHookResult

java.lang.Object

com.atlassian.bitbucket.hook.repository.RepositoryHookResult

public class RepositoryHookResult
extends Object

Describes the outcome of a repository-hook preUpdate invocation.

Since:

5.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RepositoryHookResult.Builder

Method Summary

Modifier and Type	Method and Description
static RepositoryHookResult	accepted()
boolean	equals(Object o)
List<RepositoryHookVeto>	getVetoes()
int	hashCode()
boolean	isAccepted()
boolean	isRejected()
static RepositoryHookResult	rejected(String summaryMessage, String detailMessage)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Method Detail

accepted

@Nonnull
public static RepositoryHookResult accepted()

Returns:

result that accepts the proposed request

rejected

@Nonnull
public static RepositoryHookResult rejected(@Nonnull
                                                     String summaryMessage,
                                                     @Nonnull
                                                     String detailMessage)

Parameters:

summaryMessage - a short summary of the reason the request is rejected

detailMessage - a detailed description of the reason for rejecting the request

Returns:

result that rejects the proposed request

equals

public boolean equals(Object o)

Overrides:

equals in class Object

getVetoes

@Nonnull
public List<RepositoryHookVeto> getVetoes()

Returns:

a list of vetoes that describe why the request was rejected. Empty if the request was accepted.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

isAccepted

public boolean isAccepted()

Returns:

true if the request was accepted

isRejected

public boolean isRejected()

Returns:

true if the request was rejected