1 ///////////////////////////////////////////////////////////////////////////////////////////////
2 // checkstyle: Checks Java source code and other text files for adherence to a set of rules.
3 // Copyright (C) 2001-2025 the original author or authors.
4 //
5 // This library is free software; you can redistribute it and/or
6 // modify it under the terms of the GNU Lesser General Public
7 // License as published by the Free Software Foundation; either
8 // version 2.1 of the License, or (at your option) any later version.
9 //
10 // This library is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 // Lesser General Public License for more details.
14 //
15 // You should have received a copy of the GNU Lesser General Public
16 // License along with this library; if not, write to the Free Software
17 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18 ///////////////////////////////////////////////////////////////////////////////////////////////
19
20 package com.puppycrawl.tools.checkstyle.checks.sizes;
21
22 import java.io.File;
23
24 import com.puppycrawl.tools.checkstyle.StatelessCheck;
25 import com.puppycrawl.tools.checkstyle.api.AbstractFileSetCheck;
26 import com.puppycrawl.tools.checkstyle.api.FileText;
27
28 /**
29 * <div>
30 * Checks for long source files.
31 * </div>
32 *
33 * <p>
34 * Rationale: If a source file becomes very long it is hard to understand.
35 * Therefore, long classes should usually be refactored into several
36 * individual classes that focus on a specific task.
37 * </p>
38 *
39 * @since 3.2
40 */
41 @StatelessCheck
42 public class FileLengthCheck extends AbstractFileSetCheck {
43
44 /**
45 * A key is pointing to the warning message text in "messages.properties"
46 * file.
47 */
48 public static final String MSG_KEY = "maxLen.file";
49
50 /** Default maximum number of lines. */
51 private static final int DEFAULT_MAX_LINES = 2000;
52
53 /** Specify the maximum number of lines allowed. */
54 private int max = DEFAULT_MAX_LINES;
55
56 @Override
57 protected void processFiltered(File file, FileText fileText) {
58 if (fileText.size() > max) {
59 log(1, MSG_KEY, fileText.size(), max);
60 }
61 }
62
63 /**
64 * Setter to specify the maximum number of lines allowed.
65 *
66 * @param length the maximum length of a Java source file
67 * @since 3.2
68 */
69 public void setMax(int length) {
70 max = length;
71 }
72
73 }