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

Class DatePatternConverter

java.lang.Object
org.apache.logging.log4j.core.pattern.AbstractPatternConverter
org.apache.logging.log4j.core.pattern.LogEventPatternConverter
org.apache.logging.log4j.core.pattern.DatePatternConverter
All Implemented Interfaces:
ArrayPatternConverter, PatternConverter
@Plugin(name="DatePatternConverter", category="Converter") public final class DatePatternConverter extends LogEventPatternConverter implements ArrayPatternConverter
Converts and formats the event's date in a StringBuilder.

  • Method Details

    • newInstance

      public static DatePatternConverter newInstance(String[] options)
      Obtains an instance of pattern converter.
      Parameters:
      options - options, may be null.
      Returns:
      instance of pattern converter.

    • format

      public void format(Date date, StringBuilder toAppendTo)
      Appends formatted date to string buffer.
      Parameters:
      date - date
      toAppendTo - buffer to which formatted date is appended.

    • format

      public void format(LogEvent event, StringBuilder output)
      Formats an event into a string buffer.
      Specified by:
      format in class LogEventPatternConverter
      Parameters:
      event - event to format, may not be null.
      output - string buffer to which the formatted event will be appended. May not be null.

    • format

      public void format(long epochMilli, StringBuilder output)

    • format

      public void format(Instant instant, StringBuilder output)

    • format

      public void format(Object obj, StringBuilder output)
      Formats an object into a string buffer.
      Specified by:
      format in interface PatternConverter
      Overrides:
      format in class LogEventPatternConverter
      Parameters:
      obj - event to format, may not be null.
      output - string buffer to which the formatted event will be appended. May not be null.

    • format

      public void format(StringBuilder toAppendTo, Object... objects)
      Description copied from interface: ArrayPatternConverter
      Formats an array of Objects.
      Specified by:
      format in interface ArrayPatternConverter
      Parameters:
      toAppendTo - The StringBuilder to add the content to.
      objects - The Object array.

    • getPattern

      public String getPattern()
      Gets the pattern string describing this date format.
      Returns:
      the pattern string describing this date format or null if the format does not have a pattern.

    • getTimeZone

      public TimeZone getTimeZone()
      Gets the timezone used by this date format.
      Returns:
      the timezone used by this date format.