com.atlassian.jira.event.commit

Enum OnCommitEvent.OnCommitEventDataReloadStatus

java.lang.Object

java.lang.Enum<OnCommitEvent.OnCommitEventDataReloadStatus>

com.atlassian.jira.event.commit.OnCommitEvent.OnCommitEventDataReloadStatus

All Implemented Interfaces:

Serializable, Comparable<OnCommitEvent.OnCommitEventDataReloadStatus>

Enclosing interface:

OnCommitEvent<T>

@ExperimentalApi
public static enum OnCommitEvent.OnCommitEventDataReloadStatus
extends Enum<OnCommitEvent.OnCommitEventDataReloadStatus>

Used to indicate to consumers of OnCommitEvent whether the data contained in event was reloaded after commit or not.

Enum Constant Summary

Enum Constants

Enum Constant and Description
NOT_RELOADED_ON_COMMIT The publisher has not reloaded any data after the commit.
RELOADED_ON_COMMIT The publisher explicitly ensures that they have reloaded the relevant data after commit, and put it into this event.
UNSPECIFIED The publisher has not explicitly said whether they reloaded any data or not.

Method Summary

Modifier and Type	Method and Description
static OnCommitEvent.OnCommitEventDataReloadStatus	valueOf(String name) Returns the enum constant of this type with the specified name.
static OnCommitEvent.OnCommitEventDataReloadStatus[]	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

RELOADED_ON_COMMIT

public static final OnCommitEvent.OnCommitEventDataReloadStatus RELOADED_ON_COMMIT

The publisher explicitly ensures that they have reloaded the relevant data after commit, and put it into this event.

NOT_RELOADED_ON_COMMIT

public static final OnCommitEvent.OnCommitEventDataReloadStatus NOT_RELOADED_ON_COMMIT

The publisher has not reloaded any data after the commit. This may be used by consumer to consider loaded the relevant data themselves. However, if used in conjunction with OnCommitEvent.OnCommitEventTransactionStatus it may not be necessary to reload, if the event was submitted immediately, as no transaction was in scope

UNSPECIFIED

public static final OnCommitEvent.OnCommitEventDataReloadStatus UNSPECIFIED

The publisher has not explicitly said whether they reloaded any data or not. If used in conjunction with OnCommitEvent.OnCommitEventTransactionStatus then may indicate that not necessary to reload data if not in a transaction. But the actual status is unknown.

Method Detail

values

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

Returns:

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

valueOf

public static OnCommitEvent.OnCommitEventDataReloadStatus 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