001/////////////////////////////////////////////////////////////////////////////////////////////// 002// checkstyle: Checks Java source code and other text files for adherence to a set of rules. 003// Copyright (C) 2001-2024 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 * <ul> 039 * <li> 040 * Property {@code fileExtensions} - Specify the file extensions of the files to process. 041 * Type is {@code java.lang.String[]}. 042 * Default value is {@code ""}. 043 * </li> 044 * <li> 045 * Property {@code max} - Specify the maximum number of lines allowed. 046 * Type is {@code int}. 047 * Default value is {@code 2000}. 048 * </li> 049 * </ul> 050 * 051 * <p> 052 * Parent is {@code com.puppycrawl.tools.checkstyle.Checker} 053 * </p> 054 * 055 * <p> 056 * Violation Message Keys: 057 * </p> 058 * <ul> 059 * <li> 060 * {@code maxLen.file} 061 * </li> 062 * </ul> 063 * 064 * @since 5.0 065 */ 066@StatelessCheck 067public class FileLengthCheck extends AbstractFileSetCheck { 068 069 /** 070 * A key is pointing to the warning message text in "messages.properties" 071 * file. 072 */ 073 public static final String MSG_KEY = "maxLen.file"; 074 075 /** Default maximum number of lines. */ 076 private static final int DEFAULT_MAX_LINES = 2000; 077 078 /** Specify the maximum number of lines allowed. */ 079 private int max = DEFAULT_MAX_LINES; 080 081 @Override 082 protected void processFiltered(File file, FileText fileText) { 083 if (fileText.size() > max) { 084 log(1, MSG_KEY, fileText.size(), max); 085 } 086 } 087 088 /** 089 * Setter to specify the maximum number of lines allowed. 090 * 091 * @param length the maximum length of a Java source file 092 * @since 3.2 093 */ 094 public void setMax(int length) { 095 max = length; 096 } 097 098}