Class AuditEventDefaultFormatter

java.lang.Object
com.puppycrawl.tools.checkstyle.AuditEventDefaultFormatter
All Implemented Interfaces:
AuditEventFormatter

public class AuditEventDefaultFormatter extends Object implements AuditEventFormatter
Represents the default formatter for log message. Default log message format is: [SEVERITY LEVEL] filePath:lineNo:columnNo: message. [CheckName] When the module id of the message has been set, the format is: [SEVERITY LEVEL] filePath:lineNo:columnNo: message. [ModuleId]
  • Field Details

    • LENGTH_OF_ALL_SEPARATORS

      private static final int LENGTH_OF_ALL_SEPARATORS
      Length of all separators.
      See Also:
    • SUFFIX

      private static final String SUFFIX
      Suffix of module names like XXXXCheck.
      See Also:
  • Constructor Details

    • AuditEventDefaultFormatter

      public AuditEventDefaultFormatter()
  • Method Details

    • format

      public String format(AuditEvent event)
      Description copied from interface: AuditEventFormatter
      Formats an event message.
      Specified by:
      format in interface AuditEventFormatter
      Parameters:
      event - audit event.
      Returns:
      string representation of event message.
    • calculateBufferLength

      private static int calculateBufferLength(AuditEvent event, int severityLevelNameLength)
      Returns the length of the buffer for StringBuilder. bufferLength = fileNameLength + messageLength + lengthOfAllSeparators + + severityNameLength + checkNameLength.
      Parameters:
      event - audit event.
      severityLevelNameLength - length of severity level name.
      Returns:
      the length of the buffer for StringBuilder.
    • getCheckShortName

      private static String getCheckShortName(AuditEvent event)
      Returns check name without 'Check' suffix.
      Parameters:
      event - audit event.
      Returns:
      check name without 'Check' suffix.