com.atlassian.jira.auditing

Enum AuditingRetentionPeriod

java.lang.Object

java.lang.Enum<AuditingRetentionPeriod>

com.atlassian.jira.auditing.AuditingRetentionPeriod

All Implemented Interfaces:

Serializable, Comparable<AuditingRetentionPeriod>

@ExperimentalApi
public enum AuditingRetentionPeriod
extends Enum<AuditingRetentionPeriod>

Possible values for auditing logs retention period.

Since:

v6.3

Enum Constant Summary

Enum Constants

Enum Constant and Description
ONE_MONTH
SIX_MONTHS
THREE_MONTHS
UNLIMITED

Method Summary

Modifier and Type	Method and Description
static AuditingRetentionPeriod	getByValue(String value)
static AuditingRetentionPeriod	getDefault()
String	getNameI18nKey()
static List<AuditingRetentionPeriod>	getValidValues()
String	getValue()
boolean	isShorterThan(AuditingRetentionPeriod that)
boolean	isUnlimited()
org.joda.time.DateTime	monthsIntoPast()
static AuditingRetentionPeriod	valueOf(String name) Returns the enum constant of this type with the specified name.
static AuditingRetentionPeriod[]	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

ONE_MONTH

public static final AuditingRetentionPeriod ONE_MONTH

THREE_MONTHS

public static final AuditingRetentionPeriod THREE_MONTHS

SIX_MONTHS

public static final AuditingRetentionPeriod SIX_MONTHS

UNLIMITED

public static final AuditingRetentionPeriod UNLIMITED

Method Detail

values

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

Returns:

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

valueOf

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

getValue

public String getValue()

getNameI18nKey

public String getNameI18nKey()

getByValue

@Nullable
public static AuditingRetentionPeriod getByValue(String value)

getValidValues

public static List<AuditingRetentionPeriod> getValidValues()

getDefault

public static AuditingRetentionPeriod getDefault()

isShorterThan

public boolean isShorterThan(AuditingRetentionPeriod that)

isUnlimited

public boolean isUnlimited()

monthsIntoPast

public org.joda.time.DateTime monthsIntoPast()