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.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 fileExtensions} - Specify the file extensions of the files to process.
040 * Type is {@code java.lang.String[]}.
041 * Default value is {@code ""}.
042 * </li>
043 * <li>
044 * Property {@code max} - Specify the maximum number of lines allowed.
045 * Type is {@code int}.
046 * Default value is {@code 2000}.
047 * </li>
048 * </ul>
049 * <p>
050 * Parent is {@code com.puppycrawl.tools.checkstyle.Checker}
051 * </p>
052 * <p>
053 * Violation Message Keys:
054 * </p>
055 * <ul>
056 * <li>
057 * {@code maxLen.file}
058 * </li>
059 * </ul>
060 *
061 * @since 5.0
062 */
063@StatelessCheck
064public class FileLengthCheck extends AbstractFileSetCheck {
065
066    /**
067     * A key is pointing to the warning message text in "messages.properties"
068     * file.
069     */
070    public static final String MSG_KEY = "maxLen.file";
071
072    /** Default maximum number of lines. */
073    private static final int DEFAULT_MAX_LINES = 2000;
074
075    /** Specify the maximum number of lines allowed. */
076    private int max = DEFAULT_MAX_LINES;
077
078    @Override
079    protected void processFiltered(File file, FileText fileText) {
080        if (fileText.size() > max) {
081            log(1, MSG_KEY, fileText.size(), max);
082        }
083    }
084
085    /**
086     * Setter to specify the maximum number of lines allowed.
087     *
088     * @param length the maximum length of a Java source file
089     * @since 3.2
090     */
091    public void setMax(int length) {
092        max = length;
093    }
094
095}