com.atlassian.bitbucket.settingsrestriction

Enum RestrictionProcessedState

java.lang.Object

java.lang.Enum<RestrictionProcessedState>

com.atlassian.bitbucket.settingsrestriction.RestrictionProcessedState

All Implemented Interfaces:

Serializable, Comparable<RestrictionProcessedState>

public enum RestrictionProcessedState
extends Enum<RestrictionProcessedState>

Defines the processing state for a restriction.

Since:

8.10

Enum Constant Summary

Enum Constants

Enum Constant and Description
FAILED The restriction failed to be processed after exceeding the maximum allowed retries.
IN_PROGRESS The restriction is currently being processed.
PROCESSED The restriction has been processed successfully.
UNPROCESSED The restriction is waiting to be processed and has not exceeded the maximum allowed retries.

Method Summary

Modifier and Type	Method and Description
static RestrictionProcessedState	fromId(int id)
static Set<RestrictionProcessedState>	getFinishedStates() Returns a set of states that are considered "finished".
int	getId()
static RestrictionProcessedState	valueOf(String name) Returns the enum constant of this type with the specified name.
static RestrictionProcessedState[]	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

UNPROCESSED

public static final RestrictionProcessedState UNPROCESSED

The restriction is waiting to be processed and has not exceeded the maximum allowed retries.

PROCESSED

public static final RestrictionProcessedState PROCESSED

The restriction has been processed successfully.

FAILED

public static final RestrictionProcessedState FAILED

The restriction failed to be processed after exceeding the maximum allowed retries.

IN_PROGRESS

public static final RestrictionProcessedState IN_PROGRESS

The restriction is currently being processed.

Method Detail

values

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

Returns:

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

valueOf

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

fromId

public static RestrictionProcessedState fromId(int id)

getFinishedStates

public static Set<RestrictionProcessedState> getFinishedStates()

Returns a set of states that are considered "finished". Restrictions that have a finished state will neither be retried nor picked up by the clean-up job for processing. Additionally, a restriction with a finished state can be safely deleted.

Returns:

a set of finished states

getId

public int getId()