Enum Class RollingPolicySystemProperty

java.lang.Object
java.lang.Enum<RollingPolicySystemProperty>
org.springframework.boot.logging.logback.RollingPolicySystemProperty
All Implemented Interfaces:
Serializable, Comparable<RollingPolicySystemProperty>, Constable

public enum RollingPolicySystemProperty extends Enum<RollingPolicySystemProperty>
Logback rolling policy system properties that can later be used by log configuration files.
Since:
3.2.0
See Also:
  • Enum Constant Details

    • FILE_NAME_PATTERN

      public static final RollingPolicySystemProperty FILE_NAME_PATTERN
      Logging system property for the rolled-over log file name pattern.
    • CLEAN_HISTORY_ON_START

      public static final RollingPolicySystemProperty CLEAN_HISTORY_ON_START
      Logging system property for the clean history on start flag.
    • MAX_FILE_SIZE

      public static final RollingPolicySystemProperty MAX_FILE_SIZE
      Logging system property for the file log max size.
    • TOTAL_SIZE_CAP

      public static final RollingPolicySystemProperty TOTAL_SIZE_CAP
      Logging system property for the file total size cap.
    • MAX_HISTORY

      public static final RollingPolicySystemProperty MAX_HISTORY
      Logging system property for the file log max history.
  • 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