Class AuditEventDefaultFormatter

  • All Implemented Interfaces:
    AuditEventFormatter

    public class AuditEventDefaultFormatter
    extends java.lang.Object
    implements AuditEventFormatter
    Represents the default formatter for log message. Default log message format is: [SEVERITY LEVEL] filePath:lineNo:columnNo: message. [CheckName]
    • Field Detail

      • LENGTH_OF_ALL_SEPARATORS

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

        private static final java.lang.String SUFFIX
        Suffix of module names like XXXXCheck.
        See Also:
        Constant Field Values
    • Constructor Detail

      • AuditEventDefaultFormatter

        public AuditEventDefaultFormatter()
    • Method Detail

      • format

        public java.lang.String format​(AuditEvent event)
        Description copied from interface: AuditEventFormatter
        Formats an error message.
        Specified by:
        format in interface AuditEventFormatter
        Parameters:
        event - audit event.
        Returns:
        string representation of error 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 java.lang.String getCheckShortName​(AuditEvent event)
        Returns check name without 'Check' suffix.
        Parameters:
        event - audit event.
        Returns:
        check name without 'Check' suffix.