com.atlassian.bitbucket.repository

Enum RefOrder

java.lang.Object

java.lang.Enum<RefOrder>

com.atlassian.bitbucket.repository.RefOrder

All Implemented Interfaces:

Serializable, Comparable<RefOrder>

public enum RefOrder
extends Enum<RefOrder>

Defines orderings which can be applied when retrieving references. The actual approach for applying an ordering is not established or guaranteed by this enumeration; it may vary by SCM implementation or Ref type.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALPHABETICAL Return references in ascending alphabetical order.
MODIFICATION Return references in descending modification order, with the most recently-modified references returned first.

Method Summary

Modifier and Type	Method and Description
static RefOrder	fromValueOrNull(String order) Parses the provided order, if possible.
static RefOrder	valueOf(String name) Returns the enum constant of this type with the specified name.
static RefOrder[]	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

ALPHABETICAL

public static final RefOrder ALPHABETICAL

Return references in ascending alphabetical order.

MODIFICATION

public static final RefOrder MODIFICATION

Return references in descending modification order, with the most recently-modified references returned first.

Method Detail

values

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

Returns:

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

valueOf

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

fromValueOrNull

@Nullable
public static RefOrder fromValueOrNull(@Nullable
                                                 String order)

Parses the provided order, if possible. If the order provided is null, empty or does not match a known order, null is returned.

Parameters:

order - the order to parse

Returns:

the parsed order, or null if it cannot be parsed