| 1 | /////////////////////////////////////////////////////////////////////////////////////////////// | |
| 2 | // checkstyle: Checks Java source code and other text files for adherence to a set of rules. | |
| 3 | // Copyright (C) 2001-2022 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 max} - Specify the maximum number of lines allowed. | |
| 40 | * Type is {@code int}. | |
| 41 | * Default value is {@code 2000}. | |
| 42 | * </li> | |
| 43 | * <li> | |
| 44 | * Property {@code fileExtensions} - Specify the file type extension of files to process. | |
| 45 | * Type is {@code java.lang.String[]}. | |
| 46 | * Default value is {@code ""}. | |
| 47 | * </li> | |
| 48 | * </ul> | |
| 49 | * <p> | |
| 50 | * To configure the check: | |
| 51 | * </p> | |
| 52 | * <pre> | |
| 53 | * <module name="FileLength"/> | |
| 54 | * </pre> | |
| 55 | * <p> | |
| 56 | * To configure the check to accept files with up to 1500 lines: | |
| 57 | * </p> | |
| 58 | * <pre> | |
| 59 | * <module name="FileLength"> | |
| 60 | * <property name="max" value="1500"/> | |
| 61 | * </module> | |
| 62 | * </pre> | |
| 63 | * <p> | |
| 64 | * Parent is {@code com.puppycrawl.tools.checkstyle.Checker} | |
| 65 | * </p> | |
| 66 | * <p> | |
| 67 | * Violation Message Keys: | |
| 68 | * </p> | |
| 69 | * <ul> | |
| 70 | * <li> | |
| 71 | * {@code maxLen.file} | |
| 72 | * </li> | |
| 73 | * </ul> | |
| 74 | * | |
| 75 | * @since 5.0 | |
| 76 | */ | |
| 77 | @StatelessCheck | |
| 78 | public class FileLengthCheck extends AbstractFileSetCheck { | |
| 79 | ||
| 80 | /** | |
| 81 | * A key is pointing to the warning message text in "messages.properties" | |
| 82 | * file. | |
| 83 | */ | |
| 84 | public static final String MSG_KEY = "maxLen.file"; | |
| 85 | ||
| 86 | /** Default maximum number of lines. */ | |
| 87 | private static final int DEFAULT_MAX_LINES = 2000; | |
| 88 | ||
| 89 | /** Specify the maximum number of lines allowed. */ | |
| 90 | private int max = DEFAULT_MAX_LINES; | |
| 91 | ||
| 92 | @Override | |
| 93 | protected void processFiltered(File file, FileText fileText) { | |
| 94 |
4
1. processFiltered : changed conditional boundary → KILLED 2. processFiltered : negated conditional → KILLED 3. processFiltered : removed conditional - replaced comparison check with false → KILLED 4. processFiltered : removed conditional - replaced comparison check with true → KILLED |
if (fileText.size() > max) { |
| 95 |
1
1. processFiltered : removed call to com/puppycrawl/tools/checkstyle/checks/sizes/FileLengthCheck::log → KILLED |
log(1, MSG_KEY, fileText.size(), max); |
| 96 | } | |
| 97 | } | |
| 98 | ||
| 99 | /** | |
| 100 | * Setter to specify the maximum number of lines allowed. | |
| 101 | * | |
| 102 | * @param length the maximum length of a Java source file | |
| 103 | */ | |
| 104 | public void setMax(int length) { | |
| 105 | max = length; | |
| 106 | } | |
| 107 | ||
| 108 | } | |
Mutations | ||
| 94 |
1.1 2.2 3.3 4.4 |
|
| 95 |
1.1 |