1 ///////////////////////////////////////////////////////////////////////////////////////////////
2 // checkstyle: Checks Java source code and other text files for adherence to a set of rules.
3 // Copyright (C) 2001-2024 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 * <ul>
39 * <li>
40 * Property {@code fileExtensions} - Specify the file extensions of the files to process.
41 * Type is {@code java.lang.String[]}.
42 * Default value is {@code ""}.
43 * </li>
44 * <li>
45 * Property {@code max} - Specify the maximum number of lines allowed.
46 * Type is {@code int}.
47 * Default value is {@code 2000}.
48 * </li>
49 * </ul>
50 *
51 * <p>
52 * Parent is {@code com.puppycrawl.tools.checkstyle.Checker}
53 * </p>
54 *
55 * <p>
56 * Violation Message Keys:
57 * </p>
58 * <ul>
59 * <li>
60 * {@code maxLen.file}
61 * </li>
62 * </ul>
63 *
64 * @since 5.0
65 */
66 @StatelessCheck
67 public class FileLengthCheck extends AbstractFileSetCheck {
68
69 /**
70 * A key is pointing to the warning message text in "messages.properties"
71 * file.
72 */
73 public static final String MSG_KEY = "maxLen.file";
74
75 /** Default maximum number of lines. */
76 private static final int DEFAULT_MAX_LINES = 2000;
77
78 /** Specify the maximum number of lines allowed. */
79 private int max = DEFAULT_MAX_LINES;
80
81 @Override
82 protected void processFiltered(File file, FileText fileText) {
83 if (fileText.size() > max) {
84 log(1, MSG_KEY, fileText.size(), max);
85 }
86 }
87
88 /**
89 * Setter to specify the maximum number of lines allowed.
90 *
91 * @param length the maximum length of a Java source file
92 * @since 3.2
93 */
94 public void setMax(int length) {
95 max = length;
96 }
97
98 }