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;
21
22 import com.puppycrawl.tools.checkstyle.StatelessCheck;
23 import com.puppycrawl.tools.checkstyle.api.AbstractCheck;
24 import com.puppycrawl.tools.checkstyle.api.DetailAST;
25 import com.puppycrawl.tools.checkstyle.utils.CommonUtil;
26
27 /**
28 * <p>
29 * Checks whether file contains code.
30 * Java compiler is not raising errors on files with no code or all commented out.
31 * Files which are considered to have no code:
32 * </p>
33 * <ul>
34 * <li>
35 * File with no text
36 * </li>
37 * <li>
38 * File with single-line comment(s)
39 * </li>
40 * <li>
41 * File with a multi line comment(s).
42 * </li>
43 * </ul>
44 * <p>
45 * Parent is {@code com.puppycrawl.tools.checkstyle.TreeWalker}
46 * </p>
47 * <p>
48 * Violation Message Keys:
49 * </p>
50 * <ul>
51 * <li>
52 * {@code nocode.in.file}
53 * </li>
54 * </ul>
55 *
56 * @since 8.33
57 */
58 @StatelessCheck
59 public class NoCodeInFileCheck extends AbstractCheck {
60
61 /**
62 * A key is pointing to the warning message text in "messages.properties"
63 * file.
64 */
65 public static final String MSG_KEY_NO_CODE = "nocode.in.file";
66
67 /** Line number used to log violation when no AST nodes are present in file. */
68 private static final int DEFAULT_LINE_NUMBER = 1;
69
70 @Override
71 public int[] getDefaultTokens() {
72 return getRequiredTokens();
73 }
74
75 @Override
76 public int[] getAcceptableTokens() {
77 return getRequiredTokens();
78 }
79
80 @Override
81 public int[] getRequiredTokens() {
82 return CommonUtil.EMPTY_INT_ARRAY;
83 }
84
85 @Override
86 public void finishTree(DetailAST ast) {
87 if (ast == null) {
88 log(DEFAULT_LINE_NUMBER, MSG_KEY_NO_CODE);
89 }
90 }
91 }