001///////////////////////////////////////////////////////////////////////////////////////////////
002// checkstyle: Checks Java source code and other text files for adherence to a set of rules.
003// Copyright (C) 2001-2026 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 * <div>
030 * Checks for long source files.
031 * </div>
032 *
033 * <p>
034 * Rationale: If a source file becomes very long it is hard to understand.
035 * Therefore, long classes should usually be refactored into several
036 * individual classes that focus on a specific task.
037 * </p>
038 *
039 * @since 3.2
040 */
041@StatelessCheck
042public class FileLengthCheck extends AbstractFileSetCheck {
043
044    /**
045     * A key is pointing to the warning message text in "messages.properties" file.
046     */
047    public static final String MSG_KEY = "maxLen.file";
048
049    /** Default maximum number of lines. */
050    private static final int DEFAULT_MAX_LINES = 2000;
051
052    /** Specify the maximum number of lines allowed. */
053    private int max = DEFAULT_MAX_LINES;
054
055    /**
056     * Creates a new {@code FileLengthCheck} instance.
057     */
058    public FileLengthCheck() {
059        // no code by default
060    }
061
062    @Override
063    protected void processFiltered(File file, FileText fileText) {
064        if (fileText.size() > max) {
065            log(1, MSG_KEY, fileText.size(), max);
066        }
067    }
068
069    /**
070     * Setter to specify the maximum number of lines allowed.
071     *
072     * @param length the maximum length of a Java source file
073     * @since 3.2
074     */
075    public void setMax(int length) {
076        max = length;
077    }
078
079}