Package org.apache.logging.log4j.core.pattern

Enum NamedInstantPattern

java.lang.Object
java.lang.Enum<NamedInstantPattern>
org.apache.logging.log4j.core.pattern.NamedInstantPattern
All Implemented Interfaces:
Serializable, Comparable<NamedInstantPattern>
@NullMarked public enum NamedInstantPattern extends Enum<NamedInstantPattern>
Represents named date & time patterns for formatting log timestamps.
Since:
2.26.0
See Also:

  • Enum Constant Details

  • Method Details

    • values

      public static NamedInstantPattern[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared

    • valueOf

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

    • getPattern

      public String getPattern()
      Returns the date-time pattern string compatible with DateTimeFormatter that is associated with this named pattern.
      Returns:
      the date-time pattern string for use with DateTimeFormatter