001////////////////////////////////////////////////////////////////////////////////
002// checkstyle: Checks Java source code for adherence to a set of rules.
003// Copyright (C) 2001-2017 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: [SEVERITY LEVEL] filePath:lineNo:columnNo: message. [CheckName]
030 * @author Andrei Selkin
031 */
032public class AuditEventDefaultFormatter implements AuditEventFormatter {
033
034    /** Length of all separators. */
035    private static final int LENGTH_OF_ALL_SEPARATORS = 10;
036
037    /** Suffix of module names like XXXXCheck. */
038    private static final String SUFFIX = "Check";
039
040    @Override
041    public String format(AuditEvent event) {
042        final String fileName = event.getFileName();
043        final String message = event.getMessage();
044
045        final SeverityLevel severityLevel = event.getSeverityLevel();
046        final String severityLevelName;
047        if (severityLevel == SeverityLevel.WARNING) {
048            // We change the name of severity level intentionally
049            // to shorten the length of the log message.
050            severityLevelName = "WARN";
051        }
052        else {
053            severityLevelName = severityLevel.getName().toUpperCase(Locale.US);
054        }
055
056        // Avoid StringBuffer.expandCapacity
057        final int bufLen = calculateBufferLength(event, severityLevelName.length());
058        final StringBuilder sb = new StringBuilder(bufLen);
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);
066        final String checkShortName = getCheckShortName(event);
067        sb.append(" [").append(checkShortName).append(']');
068
069        return sb.toString();
070    }
071
072    /**
073     * Returns the length of the buffer for StringBuilder.
074     * bufferLength = fileNameLength + messageLength + lengthOfAllSeparators +
075     * + severityNameLength + checkNameLength.
076     * @param event audit event.
077     * @param severityLevelNameLength length of severity level name.
078     * @return the length of the buffer for StringBuilder.
079     */
080    private static int calculateBufferLength(AuditEvent event, int severityLevelNameLength) {
081        return LENGTH_OF_ALL_SEPARATORS + event.getFileName().length()
082            + event.getMessage().length() + severityLevelNameLength
083            + getCheckShortName(event).length();
084    }
085
086    /**
087     * Returns check name without 'Check' suffix.
088     * @param event audit event.
089     * @return check name without 'Check' suffix.
090     */
091    private static String getCheckShortName(AuditEvent event) {
092        final String checkFullName = event.getSourceName();
093        final String checkShortName;
094        final int lastDotIndex = checkFullName.lastIndexOf('.');
095        if (lastDotIndex == -1) {
096            if (checkFullName.endsWith(SUFFIX)) {
097                checkShortName = checkFullName.substring(0, checkFullName.lastIndexOf(SUFFIX));
098            }
099            else {
100                checkShortName = checkFullName.substring(0, checkFullName.length());
101            }
102        }
103        else {
104            if (checkFullName.endsWith(SUFFIX)) {
105                checkShortName = checkFullName.substring(lastDotIndex + 1,
106                    checkFullName.lastIndexOf(SUFFIX));
107            }
108            else {
109                checkShortName = checkFullName.substring(lastDotIndex + 1, checkFullName.length());
110            }
111        }
112        return checkShortName;
113    }
114}