com.atlassian.bitbucket.hook.repository

Class SimplePullRequestMergeHookRequest

java.lang.Object

com.atlassian.bitbucket.hook.repository.AbstractRepositoryHookRequest

com.atlassian.bitbucket.hook.repository.SimplePullRequestMergeHookRequest

All Implemented Interfaces:

MergeHookRequest, PullRequestMergeHookRequest, RepositoryHookRequest

public class SimplePullRequestMergeHookRequest
extends AbstractRepositoryHookRequest
implements PullRequestMergeHookRequest

Basic implementation of PullRequestMergeHookRequest

Since:

5.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SimplePullRequestMergeHookRequest.Builder

Nested classes/interfaces inherited from class com.atlassian.bitbucket.hook.repository.AbstractRepositoryHookRequest

AbstractRepositoryHookRequest.AbstractBuilder<B extends AbstractRepositoryHookRequest.AbstractBuilder<B>>

Method Summary

Modifier and Type	Method and Description
PullRequestRef	getFromRef()
Optional<String>	getMergeHash()
Optional<String>	getMessage()
PullRequest	getPullRequest()
Collection<RefChange>	getRefChanges()
Optional<String>	getStrategyId()
PullRequestRef	getToRef()
boolean	isCrossRepository()

Methods inherited from class com.atlassian.bitbucket.hook.repository.AbstractRepositoryHookRequest

getContext, getRepository, getScmHookDetails, getTrigger, isDryRun

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.atlassian.bitbucket.hook.repository.RepositoryHookRequest

getContext, getRepository, getScmHookDetails, getTrigger, isDryRun

Method Detail

getFromRef

@Nonnull
public PullRequestRef getFromRef()

Specified by:

getFromRef in interface MergeHookRequest

Specified by:

getFromRef in interface PullRequestMergeHookRequest

Returns:

the pull request's from-ref

getMergeHash

@Nonnull
public Optional<String> getMergeHash()

Specified by:

getMergeHash in interface MergeHookRequest

Returns:

the merge commit hash. Can be Optional.empty() if this is a dry-run request.

getMessage

@Nonnull
public Optional<String> getMessage()

Specified by:

getMessage in interface MergeHookRequest

Returns:

the commit message. Can be Optional.empty() if this is a dry-run request.

getPullRequest

@Nonnull
public PullRequest getPullRequest()

Specified by:

getPullRequest in interface PullRequestMergeHookRequest

Returns:

the pull request being merged

getStrategyId

@Nonnull
public Optional<String> getStrategyId()

Specified by:

getStrategyId in interface MergeHookRequest

Returns:

the merge strategy ID

Since:

5.5

getToRef

@Nonnull
public PullRequestRef getToRef()

Specified by:

getToRef in interface MergeHookRequest

Specified by:

getToRef in interface PullRequestMergeHookRequest

Returns:

the pull request's to-ref

getRefChanges

@Nonnull
public Collection<RefChange> getRefChanges()

Specified by:

getRefChanges in interface RepositoryHookRequest

Overrides:

getRefChanges in class AbstractRepositoryHookRequest

Returns:

the proposed ref changes. Can be empty for some dry-run requests where the target hash is not yet known because the relevant commit hasn't been created yet. As an example, this is the case for merge requests. In these cases, the specialized request type should provide sufficient information about the proposed change. For MergeHookRequest, this would be MergeHookRequest.getFromRef() and MergeHookRequest.getToRef().

isCrossRepository

public boolean isCrossRepository()

Specified by:

isCrossRepository in interface MergeHookRequest

Returns:

true if the from-ref and the to-ref are in different repositories, otherwise false