1 ////////////////////////////////////////////////////////////////////////////////
2 // checkstyle: Checks Java source code for adherence to a set of rules.
3 // Copyright (C) 2001-2019 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.header;
21
22 import java.io.File;
23 import java.util.Arrays;
24
25 import com.puppycrawl.tools.checkstyle.StatelessCheck;
26 import com.puppycrawl.tools.checkstyle.api.FileText;
27
28 /**
29 * Checks the header of the source against a fixed header file.
30 * In default configuration,if header is not specified,
31 * the default value of header is set to null
32 * and the check does not rise any violations.
33 *
34 */
35 @StatelessCheck
36 public class HeaderCheck extends AbstractHeaderCheck {
37
38 /**
39 * A key is pointing to the warning message text in "messages.properties"
40 * file.
41 */
42 public static final String MSG_MISSING = "header.missing";
43
44 /**
45 * A key is pointing to the warning message text in "messages.properties"
46 * file.
47 */
48 public static final String MSG_MISMATCH = "header.mismatch";
49
50 /** Empty array to avoid instantiations. */
51 private static final int[] EMPTY_INT_ARRAY = new int[0];
52
53 /** The header lines to ignore in the check, sorted. */
54 private int[] ignoreLines = EMPTY_INT_ARRAY;
55
56 /**
57 * Returns true if lineNo is header lines or false.
58 * @param lineNo a line number
59 * @return if {@code lineNo} is one of the ignored header lines.
60 */
61 private boolean isIgnoreLine(int lineNo) {
62 return Arrays.binarySearch(ignoreLines, lineNo) >= 0;
63 }
64
65 /**
66 * Checks if a code line matches the required header line.
67 * @param lineNumber the line number to check against the header
68 * @param line the line contents
69 * @return true if and only if the line matches the required header line
70 */
71 private boolean isMatch(int lineNumber, String line) {
72 // skip lines we are meant to ignore
73 return isIgnoreLine(lineNumber + 1)
74 || getHeaderLines().get(lineNumber).equals(line);
75 }
76
77 /**
78 * Set the lines numbers to ignore in the header check.
79 * @param list comma separated list of line numbers to ignore in header.
80 */
81 public void setIgnoreLines(int... list) {
82 if (list.length == 0) {
83 ignoreLines = EMPTY_INT_ARRAY;
84 }
85 else {
86 ignoreLines = new int[list.length];
87 System.arraycopy(list, 0, ignoreLines, 0, list.length);
88 Arrays.sort(ignoreLines);
89 }
90 }
91
92 @Override
93 protected void processFiltered(File file, FileText fileText) {
94 if (getHeaderLines().size() > fileText.size()) {
95 log(1, MSG_MISSING);
96 }
97 else {
98 for (int i = 0; i < getHeaderLines().size(); i++) {
99 if (!isMatch(i, fileText.get(i))) {
100 log(i + 1, MSG_MISMATCH, getHeaderLines().get(i));
101 break;
102 }
103 }
104 }
105 }
106
107 @Override
108 protected void postProcessHeaderLines() {
109 // no code
110 }
111
112 }