Record Class FileLogHandlerConfig

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

public record FileLogHandlerConfig(int bufferSize, long maxFileBytes, boolean rotateDaily, int maxBackupFiles, boolean compressRotatedGzip, Formatter formatter) extends Record
Settings for FileLogHandler: buffer size, optional rotation (by size and/or calendar day), and log line format.
  • Field Details

  • Constructor Details

    • FileLogHandlerConfig

      public FileLogHandlerConfig(int bufferSize, long maxFileBytes, boolean rotateDaily, int maxBackupFiles, boolean compressRotatedGzip, Formatter formatter)
      Creates an instance of a FileLogHandlerConfig 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
    • FileLogHandlerConfig

      public FileLogHandlerConfig(int bufferSize, long maxFileBytes, boolean rotateDaily, int maxBackupFiles, Formatter formatter)
  • Method Details

    • withBufferSize

      public FileLogHandlerConfig withBufferSize(int size)
    • withMaxFileBytes

      public FileLogHandlerConfig withMaxFileBytes(long bytes)
    • withRotateDaily

      public FileLogHandlerConfig withRotateDaily(boolean daily)
    • withMaxBackupFiles

      public FileLogHandlerConfig withMaxBackupFiles(int max)
    • withCompressRotatedGzip

      public FileLogHandlerConfig withCompressRotatedGzip(boolean compress)
    • withFormatter

      public FileLogHandlerConfig withFormatter(Formatter customFormatter)
    • 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