Module com.dua3.utility.logging
Package com.dua3.utility.logging

Record Class LogEntry

java.lang.Object
java.lang.Record
com.dua3.utility.logging.LogEntry
All Implemented Interfaces:
Serializable
public record LogEntry(org.slf4j.Logger logger, Instant time, org.slf4j.event.Level level, org.slf4j.Marker marker, String msg, Object[] arguments, Throwable throwable) extends Record implements Serializable
Represents a log entry with information about the log message, time, level, logger, and optional marker and throwable.
See Also:

  • Constructor Summary

    Constructors
    Constructor
    Description
    LogEntry(org.slf4j.Logger logger, Instant time, org.slf4j.event.Level level, org.slf4j.Marker marker, String msg, Object[] arguments, Throwable throwable)
    Creates an instance of a LogEntry record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    Object[]
    arguments()
    Returns the value of the arguments record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    String
    formatMessage()
    Formats the message using MessageFormatter.basicArrayFormat.
    String
    formatThrowable()
    Formats the throwable object by printing its stack trace.
    final int
    hashCode()
    Returns a hash code value for this object.
    org.slf4j.event.Level
    level()
    Returns the value of the level record component.
    org.slf4j.Logger
    logger()
    Returns the value of the logger record component.
    org.slf4j.Marker
    marker()
    Returns the value of the marker record component.
    String
    msg()
    Returns the value of the msg record component.
    Throwable
    throwable()
    Returns the value of the throwable record component.
    Instant
    time()
    Returns the value of the time record component.
    String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • LogEntry

      public LogEntry(org.slf4j.Logger logger, Instant time, org.slf4j.event.Level level, org.slf4j.Marker marker, String msg, Object[] arguments, Throwable throwable)
      Creates an instance of a LogEntry record class.
      Parameters:
      logger - the value for the logger record component
      time - the value for the time record component
      level - the value for the level record component
      marker - the value for the marker record component
      msg - the value for the msg record component
      arguments - the value for the arguments record component
      throwable - the value for the throwable record component

  • Method Details

    • formatMessage

      public String formatMessage()
      Formats the message using MessageFormatter.basicArrayFormat.
      Returns:
      the formatted message as a string.

    • formatThrowable

      public String formatThrowable()
      Formats the throwable object by printing its stack trace. If the throwable object is null, it returns an empty string.
      Returns:
      the formatted stack trace as a string.

    • toString

      public String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • logger

      public org.slf4j.Logger logger()
      Returns the value of the logger record component.
      Returns:
      the value of the logger record component

    • time

      public Instant time()
      Returns the value of the time record component.
      Returns:
      the value of the time record component

    • level

      public org.slf4j.event.Level level()
      Returns the value of the level record component.
      Returns:
      the value of the level record component

    • marker

      public org.slf4j.Marker marker()
      Returns the value of the marker record component.
      Returns:
      the value of the marker record component

    • msg

      public String msg()
      Returns the value of the msg record component.
      Returns:
      the value of the msg record component

    • arguments

      public Object[] arguments()
      Returns the value of the arguments record component.
      Returns:
      the value of the arguments record component

    • throwable

      public Throwable throwable()
      Returns the value of the throwable record component.
      Returns:
      the value of the throwable record component