com.atlassian.crowd.manager.audit

Enum RetentionPeriod

java.lang.Object

java.lang.Enum<RetentionPeriod>

com.atlassian.crowd.manager.audit.RetentionPeriod

All Implemented Interfaces:

Serializable, Comparable<RetentionPeriod>

public enum RetentionPeriod
extends Enum<RetentionPeriod>

Determines how long the audit log entries are kept, before being removed

Since:

v2.12

Enum Constant Summary

Enum Constants

Enum Constant and Description
ONE_MONTH
SIX_MONTHS
THREE_MONTHS
UNLIMITED

Method Summary

Modifier and Type	Method and Description
Optional<Period>	get()
static RetentionPeriod	ofMonths(Integer months)
static RetentionPeriod	valueOf(String name) Returns the enum constant of this type with the specified name.
static RetentionPeriod[]	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 RetentionPeriod ONE_MONTH

THREE_MONTHS

public static final RetentionPeriod THREE_MONTHS

SIX_MONTHS

public static final RetentionPeriod SIX_MONTHS

UNLIMITED

public static final RetentionPeriod UNLIMITED

Method Detail

values

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

Returns:

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

valueOf

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

ofMonths

public static RetentionPeriod ofMonths(Integer months)

get

public Optional<Period> get()