| //////////////////////////////////////////////////////////////////////////////// |
| // checkstyle: Checks Java source code for adherence to a set of rules. |
| // Copyright (C) 2001-2017 the original author or authors. |
| // |
| // This library is free software; you can redistribute it and/or |
| // modify it under the terms of the GNU Lesser General Public |
| // License as published by the Free Software Foundation; either |
| // version 2.1 of the License, or (at your option) any later version. |
| // |
| // This library is distributed in the hope that it will be useful, |
| // but WITHOUT ANY WARRANTY; without even the implied warranty of |
| // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
| // Lesser General Public License for more details. |
| // |
| // You should have received a copy of the GNU Lesser General Public |
| // License along with this library; if not, write to the Free Software |
| // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA |
| //////////////////////////////////////////////////////////////////////////////// |
| |
| package com.puppycrawl.tools.checkstyle.checks.sizes; |
| |
| import java.io.File; |
| |
| import com.puppycrawl.tools.checkstyle.StatelessCheck; |
| import com.puppycrawl.tools.checkstyle.api.AbstractFileSetCheck; |
| import com.puppycrawl.tools.checkstyle.api.FileText; |
| |
| /** |
| * <p> |
| * Checks for long source files. |
| * </p> |
| * <p> |
| * Rationale: If a source file becomes very long it is hard to understand. |
| * Therefore long classes should usually be refactored into several |
| * individual classes that focus on a specific task. |
| * </p> |
| * <p> |
| * The default maximum file length is 2000 lines. To change the maximum |
| * number of lines, set property max. |
| * </p> |
| * <p> |
| * An example of how to configure the check is: |
| * </p> |
| * <pre> |
| * <module name="FileLength"/> |
| * </pre> |
| * <p> |
| * An example of how to configure the check so that it accepts files with at |
| * most 1500 lines is: |
| * </p> |
| * <pre> |
| * <module name="FileLength"> |
| * <property name="max" value="1500"/> |
| * </module> |
| * </pre> |
| * @author Lars Kühne |
| */ |
| @StatelessCheck |
| public class FileLengthCheck extends AbstractFileSetCheck { |
| |
| /** |
| * A key is pointing to the warning message text in "messages.properties" |
| * file. |
| */ |
| public static final String MSG_KEY = "maxLen.file"; |
| |
| /** Default maximum number of lines. */ |
| private static final int DEFAULT_MAX_LINES = 2000; |
| |
| /** The maximum number of lines. */ |
| private int max = DEFAULT_MAX_LINES; |
| |
| @Override |
| protected void processFiltered(File file, FileText fileText) { |
| if (fileText.size() > max) { |
| log(1, MSG_KEY, fileText.size(), max); |
| } |
| } |
| |
| /** |
| * Sets the maximum length of a Java source file. |
| * @param length the maximum length of a Java source file |
| */ |
| public void setMax(int length) { |
| max = length; |
| } |
| |
| } |