001////////////////////////////////////////////////////////////////////////////////
002// checkstyle: Checks Java source code for adherence to a set of rules.
003// Copyright (C) 2001-2019 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.checks.sizes;
021
022import java.io.File;
023
024import com.puppycrawl.tools.checkstyle.StatelessCheck;
025import com.puppycrawl.tools.checkstyle.api.AbstractFileSetCheck;
026import com.puppycrawl.tools.checkstyle.api.FileText;
027
028/**
029 * <p>
030 * Checks for long source files.
031 * </p>
032 * <p>
033 * Rationale: If a source file becomes very long it is hard to understand.
034 * Therefore long classes should usually be refactored into several
035 * individual classes that focus on a specific task.
036 * </p>
037 * <ul>
038 * <li>
039 * Property {@code max} - Specify the maximum number of lines allowed.
040 * Default value is {@code 2000}.
041 * </li>
042 * <li>
043 * Property {@code fileExtensions} - Specify the file type extension of files to process.
044 * Default value is {@code all files}.
045 * </li>
046 * </ul>
047 * <p>
048 * To configure the check:
049 * </p>
050 * <pre>
051 * &lt;module name="FileLength"/&gt;
052 * </pre>
053 * <p>
054 * To configure the check to accept files with up to 1500 lines:
055 * </p>
056 * <pre>
057 * &lt;module name="FileLength"&gt;
058 *   &lt;property name="max" value="1500"/&gt;
059 * &lt;/module&gt;
060 * </pre>
061 *
062 * @since 5.0
063 */
064@StatelessCheck
065public class FileLengthCheck extends AbstractFileSetCheck {
066
067    /**
068     * A key is pointing to the warning message text in "messages.properties"
069     * file.
070     */
071    public static final String MSG_KEY = "maxLen.file";
072
073    /** Default maximum number of lines. */
074    private static final int DEFAULT_MAX_LINES = 2000;
075
076    /** Specify the maximum number of lines allowed. */
077    private int max = DEFAULT_MAX_LINES;
078
079    @Override
080    protected void processFiltered(File file, FileText fileText) {
081        if (fileText.size() > max) {
082            log(1, MSG_KEY, fileText.size(), max);
083        }
084    }
085
086    /**
087     * Setter to specify the maximum number of lines allowed.
088     *
089     * @param length the maximum length of a Java source file
090     */
091    public void setMax(int length) {
092        max = length;
093    }
094
095}