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 * <p>
30 * Checks for long source files.
31 * </p>
32 * <p>
33 * Rationale: If a source file becomes very long it is hard to understand.
34 * Therefore, long classes should usually be refactored into several
35 * individual classes that focus on a specific task.
36 * </p>
37 * <ul>
38 * <li>
39 * Property {@code fileExtensions} - Specify the file extensions of the files to process.
40 * Type is {@code java.lang.String[]}.
41 * Default value is {@code ""}.
42 * </li>
43 * <li>
44 * Property {@code max} - Specify the maximum number of lines allowed.
45 * Type is {@code int}.
46 * Default value is {@code 2000}.
47 * </li>
48 * </ul>
49 * <p>
50 * Parent is {@code com.puppycrawl.tools.checkstyle.Checker}
51 * </p>
52 * <p>
53 * Violation Message Keys:
54 * </p>
55 * <ul>
56 * <li>
57 * {@code maxLen.file}
58 * </li>
59 * </ul>
60 *
61 * @since 5.0
62 */
63 @StatelessCheck
64 public class FileLengthCheck extends AbstractFileSetCheck {
65
66 /**
67 * A key is pointing to the warning message text in "messages.properties"
68 * file.
69 */
70 public static final String MSG_KEY = "maxLen.file";
71
72 /** Default maximum number of lines. */
73 private static final int DEFAULT_MAX_LINES = 2000;
74
75 /** Specify the maximum number of lines allowed. */
76 private int max = DEFAULT_MAX_LINES;
77
78 @Override
79 protected void processFiltered(File file, FileText fileText) {
80 if (fileText.size() > max) {
81 log(1, MSG_KEY, fileText.size(), max);
82 }
83 }
84
85 /**
86 * Setter to specify the maximum number of lines allowed.
87 *
88 * @param length the maximum length of a Java source file
89 * @since 3.2
90 */
91 public void setMax(int length) {
92 max = length;
93 }
94
95 }