001////////////////////////////////////////////////////////////////////////////////
002// checkstyle: Checks Java source code for adherence to a set of rules.
003// Copyright (C) 2001-2020 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 * Type is {@code int}.
041 * Default value is {@code 2000}.
042 * </li>
043 * <li>
044 * Property {@code fileExtensions} - Specify the file type extension of files to process.
045 * Type is {@code java.lang.String[]}.
046 * Default value is {@code all files}.
047 * </li>
048 * </ul>
049 * <p>
050 * To configure the check:
051 * </p>
052 * <pre>
053 * &lt;module name="FileLength"/&gt;
054 * </pre>
055 * <p>
056 * To configure the check to accept files with up to 1500 lines:
057 * </p>
058 * <pre>
059 * &lt;module name="FileLength"&gt;
060 *   &lt;property name="max" value="1500"/&gt;
061 * &lt;/module&gt;
062 * </pre>
063 * <p>
064 * Parent is {@code com.puppycrawl.tools.checkstyle.Checker}
065 * </p>
066 * <p>
067 * Violation Message Keys:
068 * </p>
069 * <ul>
070 * <li>
071 * {@code maxLen.file}
072 * </li>
073 * </ul>
074 *
075 * @since 5.0
076 */
077@StatelessCheck
078public class FileLengthCheck extends AbstractFileSetCheck {
079
080    /**
081     * A key is pointing to the warning message text in "messages.properties"
082     * file.
083     */
084    public static final String MSG_KEY = "maxLen.file";
085
086    /** Default maximum number of lines. */
087    private static final int DEFAULT_MAX_LINES = 2000;
088
089    /** Specify the maximum number of lines allowed. */
090    private int max = DEFAULT_MAX_LINES;
091
092    @Override
093    protected void processFiltered(File file, FileText fileText) {
094        if (fileText.size() > max) {
095            log(1, MSG_KEY, fileText.size(), max);
096        }
097    }
098
099    /**
100     * Setter to specify the maximum number of lines allowed.
101     *
102     * @param length the maximum length of a Java source file
103     */
104    public void setMax(int length) {
105        max = length;
106    }
107
108}