Enum Class RollingPolicySystemProperty

java.lang.Object

java.lang.Enum<RollingPolicySystemProperty>

org.springframework.boot.logging.log4j2.RollingPolicySystemProperty

All Implemented Interfaces:

Serializable, Comparable<RollingPolicySystemProperty>, Constable

public enum RollingPolicySystemProperty
extends Enum<RollingPolicySystemProperty>

Log4j2 rolling policy system properties that can later be used by log configuration files.

Since:

4.1.0

Author:

HoJoo Moon, Stephane Nicoll

See Also:

• Log4j2LoggingSystemProperties

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CRON	Logging system property for the cron based schedule.
FILE_NAME_PATTERN	Logging system property for the rolled-over log file name pattern.
MAX_FILE_SIZE	Logging system property for the file log max size.
MAX_HISTORY	Logging system property for the file log max history.
STRATEGY	Logging system property for the rolling policy strategy.
TIME_INTERVAL	Logging system property for the rolling policy time interval.
TIME_MODULATE	Logging system property for the rolling policy time modulate flag.

Method Summary

Modifier and Type	Method	Description
String	getEnvironmentVariableName()	Return the name of environment variable that can be used to access this property.
static RollingPolicySystemProperty	valueOf(String name)	Returns the enum constant of this class with the specified name.
static RollingPolicySystemProperty[]	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

FILE_NAME_PATTERN

public static final RollingPolicySystemProperty FILE_NAME_PATTERN

Logging system property for the rolled-over log file name pattern.

MAX_FILE_SIZE

public static final RollingPolicySystemProperty MAX_FILE_SIZE

Logging system property for the file log max size.

MAX_HISTORY

public static final RollingPolicySystemProperty MAX_HISTORY

Logging system property for the file log max history.

STRATEGY

public static final RollingPolicySystemProperty STRATEGY

Logging system property for the rolling policy strategy.

TIME_INTERVAL

public static final RollingPolicySystemProperty TIME_INTERVAL

Logging system property for the rolling policy time interval.

TIME_MODULATE

public static final RollingPolicySystemProperty TIME_MODULATE

Logging system property for the rolling policy time modulate flag.

CRON

public static final RollingPolicySystemProperty CRON

Logging system property for the cron based schedule.

Method Details

values

public static RollingPolicySystemProperty[] 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 RollingPolicySystemProperty 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

getEnvironmentVariableName

public String getEnvironmentVariableName()

Return the name of environment variable that can be used to access this property.

Returns:

the environment variable name