com.atlassian.bitbucket.pull

Enum PullRequestOrder

java.lang.Object

java.lang.Enum<PullRequestOrder>

com.atlassian.bitbucket.pull.PullRequestOrder

All Implemented Interfaces:

Serializable, Comparable<PullRequestOrder>

public enum PullRequestOrder
extends Enum<PullRequestOrder>

Specifies the order in which a list of results should be returned - multiple criteria can be applied.

See Also:

PullRequestSearchRequest.getOrders()

Enum Constant Summary

Enum Constants

Enum Constant and Description
CLOSED_DATE Indicates pull requests will be ordered by closed timestamp in descending order.
DRAFT_STATUS Indicates pull requests should be shown in an order based on status.
NEWEST Indicates newer pull requests should be shown before older ones
OLDEST Indicates older pull requests should be shown before newer ones
PARTICIPANT_STATUS Indicates pull requests should be shown in an order based on status.

Method Summary

Modifier and Type	Method and Description
static PullRequestOrder	fromString(String stringValue, PullRequestOrder defaultValue) Coerces a string to a PullRequestOrder or returns the supplied default value if this is not possible.
static PullRequestOrder	getDefaultOrder()
static PullRequestOrder	valueOf(String name) Returns the enum constant of this type with the specified name.
static PullRequestOrder[]	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

OLDEST

public static final PullRequestOrder OLDEST

Indicates older pull requests should be shown before newer ones

NEWEST

public static final PullRequestOrder NEWEST

Indicates newer pull requests should be shown before older ones

DRAFT_STATUS

public static final PullRequestOrder DRAFT_STATUS

Indicates pull requests should be shown in an order based on status. For PRs where the draft status is the same, NEWEST order will be applied. WARNING: This value is experimental and is subject to change between minor versions of Bitbucket. It is not for consumption and no consideration will be given to nor guarantees made for its compatibility between releases. Basically, don't use it unless you're a Bitbucket developer.

Since:

8.17

PARTICIPANT_STATUS

public static final PullRequestOrder PARTICIPANT_STATUS

Indicates pull requests should be shown in an order based on status. For PRs where the participant has the same status, NEWEST order will be applied.

Since:

4.4

See Also:

for more information on restrictions

CLOSED_DATE

public static final PullRequestOrder CLOSED_DATE

Indicates pull requests will be ordered by closed timestamp in descending order. Specifically open pull requests will be shown before closed ones, then most recently closed pull requests. Where pull requests are still in the open state newer pull requests are be shown before older ones (i.e. last updated descending).

Since:

4.10

Method Detail

values

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

Returns:

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

valueOf

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

fromString

public static PullRequestOrder fromString(@Nullable
                                          String stringValue,
                                          @Nullable
                                          PullRequestOrder defaultValue)

Coerces a string to a PullRequestOrder or returns the supplied default value if this is not possible.

Parameters:

stringValue - the string value of the pull request

defaultValue - the default value to return if coercion is not possible

Returns:

the corresponding PullRequestOrder instance

getDefaultOrder

@Nonnull
public static PullRequestOrder getDefaultOrder()

Returns:

NEWEST