Record Class AsyncFileLogHandlerConfig

java.lang.Object
java.lang.Record
io.github.connellite.logger.AsyncFileLogHandlerConfig

public record AsyncFileLogHandlerConfig(int bufferSize, long maxFileBytes, boolean rotateDaily, int maxBackupFiles, boolean compressRotatedGzip, Formatter formatter, int overflowDropType, int maxRecords) extends Record
Settings for AsyncFileLogHandler: everything FileLogHandlerConfig carries, plus the queue limit and what to do when that queue is full.
  • Field Details

    • OVERFLOW_DROP_LAST

      public static final int OVERFLOW_DROP_LAST
      Overflow policy: drop the last record in the queue.
      See Also:
    • OVERFLOW_DROP_FIRST

      public static final int OVERFLOW_DROP_FIRST
      Overflow policy: drop the first (oldest) record in the queue.
      See Also:
    • OVERFLOW_DROP_FLUSH

      public static final int OVERFLOW_DROP_FLUSH
      Overflow policy: wait until the queue accepts the record.
      See Also:
    • OVERFLOW_DROP_CURRENT

      public static final int OVERFLOW_DROP_CURRENT
      Overflow policy: drop the current record.
      See Also:
    • DEFAULT

      public static final AsyncFileLogHandlerConfig DEFAULT
      Same file settings as FileLogHandlerConfig.DEFAULT, drop-last overflow, queue of 10000.
  • Constructor Details

    • AsyncFileLogHandlerConfig

      public AsyncFileLogHandlerConfig(int bufferSize, long maxFileBytes, boolean rotateDaily, int maxBackupFiles, boolean compressRotatedGzip, Formatter formatter, int overflowDropType, int maxRecords)
      Creates an instance of a AsyncFileLogHandlerConfig record class.
      Parameters:
      bufferSize - the value for the bufferSize record component
      maxFileBytes - the value for the maxFileBytes record component
      rotateDaily - the value for the rotateDaily record component
      maxBackupFiles - the value for the maxBackupFiles record component
      compressRotatedGzip - the value for the compressRotatedGzip record component
      formatter - the value for the formatter record component
      overflowDropType - the value for the overflowDropType record component
      maxRecords - the value for the maxRecords record component
    • AsyncFileLogHandlerConfig

      public AsyncFileLogHandlerConfig(FileLogHandlerConfig fileConfig, int overflowDropType, int maxRecords)
  • Method Details

    • fileLogHandlerConfig

      public FileLogHandlerConfig fileLogHandlerConfig()
      File settings carried by this config, without the queue.
    • withBufferSize

      public AsyncFileLogHandlerConfig withBufferSize(int size)
    • withMaxFileBytes

      public AsyncFileLogHandlerConfig withMaxFileBytes(long bytes)
    • withRotateDaily

      public AsyncFileLogHandlerConfig withRotateDaily(boolean daily)
    • withMaxBackupFiles

      public AsyncFileLogHandlerConfig withMaxBackupFiles(int max)
    • withCompressRotatedGzip

      public AsyncFileLogHandlerConfig withCompressRotatedGzip(boolean compress)
    • withFormatter

      public AsyncFileLogHandlerConfig withFormatter(Formatter customFormatter)
    • withOverflowDropType

      public AsyncFileLogHandlerConfig withOverflowDropType(int dropType)
    • withMaxRecords

      public AsyncFileLogHandlerConfig withMaxRecords(int records)
    • toString

      public final 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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      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.
    • bufferSize

      public int bufferSize()
      Returns the value of the bufferSize record component.
      Returns:
      the value of the bufferSize record component
    • maxFileBytes

      public long maxFileBytes()
      Returns the value of the maxFileBytes record component.
      Returns:
      the value of the maxFileBytes record component
    • rotateDaily

      public boolean rotateDaily()
      Returns the value of the rotateDaily record component.
      Returns:
      the value of the rotateDaily record component
    • maxBackupFiles

      public int maxBackupFiles()
      Returns the value of the maxBackupFiles record component.
      Returns:
      the value of the maxBackupFiles record component
    • compressRotatedGzip

      public boolean compressRotatedGzip()
      Returns the value of the compressRotatedGzip record component.
      Returns:
      the value of the compressRotatedGzip record component
    • formatter

      public Formatter formatter()
      Returns the value of the formatter record component.
      Returns:
      the value of the formatter record component
    • overflowDropType

      public int overflowDropType()
      Returns the value of the overflowDropType record component.
      Returns:
      the value of the overflowDropType record component
    • maxRecords

      public int maxRecords()
      Returns the value of the maxRecords record component.
      Returns:
      the value of the maxRecords record component