1 ///////////////////////////////////////////////////////////////////////////////////////////////
2 // checkstyle: Checks Java source code and other text files for adherence to a set of rules.
3 // Copyright (C) 2001-2024 the original author or authors.
4 //
5 // This library is free software; you can redistribute it and/or
6 // modify it under the terms of the GNU Lesser General Public
7 // License as published by the Free Software Foundation; either
8 // version 2.1 of the License, or (at your option) any later version.
9 //
10 // This library is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 // Lesser General Public License for more details.
14 //
15 // You should have received a copy of the GNU Lesser General Public
16 // License along with this library; if not, write to the Free Software
17 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18 ///////////////////////////////////////////////////////////////////////////////////////////////
19
20 package com.puppycrawl.tools.checkstyle;
21
22 import java.util.Locale;
23
24 import com.puppycrawl.tools.checkstyle.api.AuditEvent;
25 import com.puppycrawl.tools.checkstyle.api.SeverityLevel;
26
27 /**
28 * Represents the default formatter for log message.
29 * Default log message format is:
30 * [SEVERITY LEVEL] filePath:lineNo:columnNo: message. [CheckName]
31 * When the module id of the message has been set, the format is:
32 * [SEVERITY LEVEL] filePath:lineNo:columnNo: message. [ModuleId]
33 */
34 public class AuditEventDefaultFormatter implements AuditEventFormatter {
35
36 /** Length of all separators. */
37 private static final int LENGTH_OF_ALL_SEPARATORS = 10;
38
39 /** Suffix of module names like XXXXCheck. */
40 private static final String SUFFIX = "Check";
41
42 @Override
43 public String format(AuditEvent event) {
44 final String fileName = event.getFileName();
45 final String message = event.getMessage();
46
47 final SeverityLevel severityLevel = event.getSeverityLevel();
48 final String severityLevelName;
49 if (severityLevel == SeverityLevel.WARNING) {
50 // We change the name of severity level intentionally
51 // to shorten the length of the log message.
52 severityLevelName = "WARN";
53 }
54 else {
55 severityLevelName = severityLevel.getName().toUpperCase(Locale.US);
56 }
57
58 final StringBuilder sb = initStringBuilderWithOptimalBuffer(event, severityLevelName);
59
60 sb.append('[').append(severityLevelName).append("] ")
61 .append(fileName).append(':').append(event.getLine());
62 if (event.getColumn() > 0) {
63 sb.append(':').append(event.getColumn());
64 }
65 sb.append(": ").append(message).append(" [");
66 if (event.getModuleId() == null) {
67 final String checkShortName = getCheckShortName(event);
68 sb.append(checkShortName);
69 }
70 else {
71 sb.append(event.getModuleId());
72 }
73 sb.append(']');
74
75 return sb.toString();
76 }
77
78 /**
79 * Returns the StringBuilder that should avoid StringBuffer.expandCapacity.
80 * bufferLength = fileNameLength + messageLength + lengthOfAllSeparators +
81 * + severityNameLength + checkNameLength.
82 * Method is excluded from pitest validation.
83 *
84 * @param event audit event.
85 * @param severityLevelName severity level name.
86 * @return optimal StringBuilder.
87 */
88 private static StringBuilder initStringBuilderWithOptimalBuffer(AuditEvent event,
89 String severityLevelName) {
90 final int bufLen = LENGTH_OF_ALL_SEPARATORS + event.getFileName().length()
91 + event.getMessage().length() + severityLevelName.length()
92 + getCheckShortName(event).length();
93 return new StringBuilder(bufLen);
94 }
95
96 /**
97 * Returns check name without 'Check' suffix.
98 *
99 * @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 }