001/////////////////////////////////////////////////////////////////////////////////////////////// 002// checkstyle: Checks Java source code and other text files for adherence to a set of rules. 003// Copyright (C) 2001-2024 the original author or authors. 004// 005// This library is free software; you can redistribute it and/or 006// modify it under the terms of the GNU Lesser General Public 007// License as published by the Free Software Foundation; either 008// version 2.1 of the License, or (at your option) any later version. 009// 010// This library is distributed in the hope that it will be useful, 011// but WITHOUT ANY WARRANTY; without even the implied warranty of 012// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 013// Lesser General Public License for more details. 014// 015// You should have received a copy of the GNU Lesser General Public 016// License along with this library; if not, write to the Free Software 017// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA 018/////////////////////////////////////////////////////////////////////////////////////////////// 019 020package com.puppycrawl.tools.checkstyle; 021 022import java.util.Locale; 023 024import com.puppycrawl.tools.checkstyle.api.AuditEvent; 025import com.puppycrawl.tools.checkstyle.api.SeverityLevel; 026 027/** 028 * Represents the default formatter for log message. 029 * Default log message format is: 030 * [SEVERITY LEVEL] filePath:lineNo:columnNo: message. [CheckName] 031 * When the module id of the message has been set, the format is: 032 * [SEVERITY LEVEL] filePath:lineNo:columnNo: message. [ModuleId] 033 */ 034public class AuditEventDefaultFormatter implements AuditEventFormatter { 035 036 /** Length of all separators. */ 037 private static final int LENGTH_OF_ALL_SEPARATORS = 10; 038 039 /** Suffix of module names like XXXXCheck. */ 040 private static final String SUFFIX = "Check"; 041 042 @Override 043 public String format(AuditEvent event) { 044 final String fileName = event.getFileName(); 045 final String message = event.getMessage(); 046 047 final SeverityLevel severityLevel = event.getSeverityLevel(); 048 final String severityLevelName; 049 if (severityLevel == SeverityLevel.WARNING) { 050 // We change the name of severity level intentionally 051 // to shorten the length of the log message. 052 severityLevelName = "WARN"; 053 } 054 else { 055 severityLevelName = severityLevel.getName().toUpperCase(Locale.US); 056 } 057 058 final StringBuilder sb = initStringBuilderWithOptimalBuffer(event, severityLevelName); 059 060 sb.append('[').append(severityLevelName).append("] ") 061 .append(fileName).append(':').append(event.getLine()); 062 if (event.getColumn() > 0) { 063 sb.append(':').append(event.getColumn()); 064 } 065 sb.append(": ").append(message).append(" ["); 066 if (event.getModuleId() == null) { 067 final String checkShortName = getCheckShortName(event); 068 sb.append(checkShortName); 069 } 070 else { 071 sb.append(event.getModuleId()); 072 } 073 sb.append(']'); 074 075 return sb.toString(); 076 } 077 078 /** 079 * Returns the StringBuilder that should avoid StringBuffer.expandCapacity. 080 * bufferLength = fileNameLength + messageLength + lengthOfAllSeparators + 081 * + severityNameLength + checkNameLength. 082 * Method is excluded from pitest validation. 083 * 084 * @param event audit event. 085 * @param severityLevelName severity level name. 086 * @return optimal StringBuilder. 087 */ 088 private static StringBuilder initStringBuilderWithOptimalBuffer(AuditEvent event, 089 String severityLevelName) { 090 final int bufLen = LENGTH_OF_ALL_SEPARATORS + event.getFileName().length() 091 + event.getMessage().length() + severityLevelName.length() 092 + getCheckShortName(event).length(); 093 return new StringBuilder(bufLen); 094 } 095 096 /** 097 * Returns check name without 'Check' suffix. 098 * 099 * @param event audit event. 100 * @return check name without 'Check' suffix. 101 */ 102 private static String getCheckShortName(AuditEvent event) { 103 final String checkFullName = event.getSourceName(); 104 String checkShortName = checkFullName.substring(checkFullName.lastIndexOf('.') + 1); 105 if (checkShortName.endsWith(SUFFIX)) { 106 final int endIndex = checkShortName.length() - SUFFIX.length(); 107 checkShortName = checkShortName.substring(0, endIndex); 108 } 109 return checkShortName; 110 } 111 112}