Package com.atlassian.bitbucket.pull.mergequeue

Class SimpleMergeQueueCheckResult

java.lang.Object

com.atlassian.bitbucket.pull.mergequeue.SimpleMergeQueueCheckResult

All Implemented Interfaces:

MergeQueueCheckResult

public final class SimpleMergeQueueCheckResult
extends Object
implements MergeQueueCheckResult

A simple, immutable implementation of MergeQueueCheckResult.

 // Accepted result
 MergeQueueCheckResult accepted = new SimpleMergeQueueCheckResult.Builder(State.ACCEPTED)
         .build();

 // Pending result with a reason and details URL
 MergeQueueCheckResult pending = new SimpleMergeQueueCheckResult.Builder(State.PENDING)
         .reason(new I18nKey("plugin.queue.check.build.inprogress", buildName))
         .detailsUrl("https://ci.example.com/build/123")
         .build();

 // Rejected result with a reason and details URL
 MergeQueueCheckResult rejected = new SimpleMergeQueueCheckResult.Builder(State.REJECTED)
         .reason(new I18nKey("plugin.queue.check.build.failed", buildName))
         .detailsUrl(buildUrl)
         .build();
 

Since:

10.2

See Also:

• MergeQueueCheck
• MergeQueueCheckResult

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	SimpleMergeQueueCheckResult.Builder

Nested classes/interfaces inherited from interface com.atlassian.bitbucket.pull.mergequeue.MergeQueueCheckResult

MergeQueueCheckResult.State

Method Summary

Modifier and Type	Method	Description
Optional<String>	getDetailsUrl()	A URL displayed in the UI, linking to external systems (such as CI build pages) for more information.
Optional<com.atlassian.bitbucket.i18n.I18nKey>	getReason()	A reason for the result, displayed in the UI.
MergeQueueCheckResult.State	getState()	A state to control whether the pull request can merge, should wait, or be removed from the merge queue.

Methods inherited from class java.lang.Object

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

Method Details

getDetailsUrl

@Nonnull
public Optional<String> getDetailsUrl()

Description copied from interface: MergeQueueCheckResult

A URL displayed in the UI, linking to external systems (such as CI build pages) for more information.

Specified by:

getDetailsUrl in interface MergeQueueCheckResult

Returns:

a URL or Optional.empty() if no URL is available

getReason

@Nonnull
public Optional<com.atlassian.bitbucket.i18n.I18nKey> getReason()

Description copied from interface: MergeQueueCheckResult

A reason for the result, displayed in the UI. Especially important for REJECTED and PENDING states, where users need to understand why their pull request is still waiting / was removed from the queue. A default message may be used if none is provided.

Specified by:

getReason in interface MergeQueueCheckResult

Returns:

an I18nKey containing the i18n message key and arguments, or Optional.empty()

getState

@Nonnull
public MergeQueueCheckResult.State getState()

Description copied from interface: MergeQueueCheckResult

A state to control whether the pull request can merge, should wait, or be removed from the merge queue.

Specified by:

getState in interface MergeQueueCheckResult

Returns:

the state of the check result