Enum Class RollingPolicyStrategy

java.lang.Object

java.lang.Enum<RollingPolicyStrategy>

org.springframework.boot.logging.log4j2.RollingPolicyStrategy

All Implemented Interfaces:

Serializable, Comparable<RollingPolicyStrategy>, Constable

public enum RollingPolicyStrategy
extends Enum<RollingPolicyStrategy>

Available rolling policy strategies.

Since:

4.1.0

Author:

Stephane Nicoll

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CRON	Roll a file over based on a cron schedule.
SIZE	Roll a file over based on its size.
SIZE_AND_TIME	Roll a file over based on its size and time.
TIME	Roll a file over based on time.

Method Summary

Modifier and Type	Method	Description
static RollingPolicyStrategy	valueOf(String name)	Returns the enum constant of this class with the specified name.
static RollingPolicyStrategy[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

SIZE

public static final RollingPolicyStrategy SIZE

Roll a file over based on its size.

TIME

public static final RollingPolicyStrategy TIME

Roll a file over based on time.

SIZE_AND_TIME

public static final RollingPolicyStrategy SIZE_AND_TIME

Roll a file over based on its size and time.

CRON

public static final RollingPolicyStrategy CRON

Roll a file over based on a cron schedule.

Method Details

values

public static RollingPolicyStrategy[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static RollingPolicyStrategy valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null