blob: d2727f0df4392ac9a73cd6901f5dfe181531dd4e [file] [log] [blame]
tom0eb04ca2014-08-25 14:34:51 -07001<?xml version="1.0"?>
alshabibab984662014-12-04 18:56:18 -08002<!--
Brian O'Connora09fe5b2017-08-03 21:12:30 -07003 ~ Copyright 2014-present Open Networking Foundation
alshabibab984662014-12-04 18:56:18 -08004 ~
5 ~ Licensed under the Apache License, Version 2.0 (the "License");
6 ~ you may not use this file except in compliance with the License.
7 ~ You may obtain a copy of the License at
8 ~
9 ~ http://www.apache.org/licenses/LICENSE-2.0
10 ~
11 ~ Unless required by applicable law or agreed to in writing, software
12 ~ distributed under the License is distributed on an "AS IS" BASIS,
13 ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 ~ See the License for the specific language governing permissions and
15 ~ limitations under the License.
16 -->
tom0eb04ca2014-08-25 14:34:51 -070017<!DOCTYPE module PUBLIC
18 "-//Puppy Crawl//DTD Check Configuration 1.3//EN"
19 "http://www.puppycrawl.com/dtds/configuration_1_3.dtd">
20
21
22<!--
23
24 Checkstyle configuration that checks the sun coding conventions from:
25
26 - the Java Language Specification at
27 http://java.sun.com/docs/books/jls/second_edition/html/index.html
28
29 - the Sun Code Conventions at http://java.sun.com/docs/codeconv/
30
31 - the Javadoc guidelines at
32 http://java.sun.com/j2se/javadoc/writingdoccomments/index.html
33
34 - the JDK Api documentation http://java.sun.com/j2se/docs/api/index.html
35
36 - some best practices
37
38 Checkstyle is very configurable. Be sure to read the documentation at
39 http://checkstyle.sf.net (or in your downloaded distribution).
40
41 Most Checks are configurable, be sure to consult the documentation.
42
43 To completely disable a check, just comment it out or delete it from the file.
44
45 Finally, it is worth reading the documentation.
46
47-->
48
49
50<!--
51 The default severity setting in checkstyle is 'error', so some
52 of the rules below are configured to change the severity to
Ray Milkey85267002016-11-16 11:06:35 -080053 'warning'. Over time, these 'warning' settings should be
tom0eb04ca2014-08-25 14:34:51 -070054 removed as more of the ONOS source code is modified to
55 follow the recommended rules.
56-->
57
58
tom0eb04ca2014-08-25 14:34:51 -070059<module name="Checker">
60 <!--
61 If you set the basedir property below, then all reported file
62 names will be relative to the specified directory. See
63 http://checkstyle.sourceforge.net/5.x/config.html#Checker
64
65 <property name="basedir" value="${basedir}"/>
66 -->
67 <!-- Checks that a package-info.java file exists for each package. -->
68 <!-- See http://checkstyle.sf.net/config_javadoc.html#JavadocPackage -->
Ray Milkeyccda0b52015-10-30 16:51:06 -070069 <module name="JavadocPackage"/>
tom0eb04ca2014-08-25 14:34:51 -070070
71 <!-- Checks whether files end with a new line. -->
72 <!-- See http://checkstyle.sf.net/config_misc.html#NewlineAtEndOfFile -->
73 <module name="NewlineAtEndOfFile"/>
74
75 <!-- Checks that property files contain the same keys. -->
76 <!-- See http://checkstyle.sf.net/config_misc.html#Translation -->
77 <module name="Translation"/>
78
79 <!-- Checks for Size Violations. -->
80 <!-- See http://checkstyle.sf.net/config_sizes.html -->
81 <module name="FileLength"/>
82
83 <!-- Checks for whitespace -->
84 <!-- See http://checkstyle.sf.net/config_whitespace.html -->
85 <module name="FileTabCharacter"/>
86
87 <!-- Miscellaneous other checks. -->
88 <!-- See http://checkstyle.sf.net/config_misc.html -->
89 <module name="RegexpSingleline">
90 <property name="format" value="\s+$"/>
91 <property name="minimum" value="0"/>
92 <property name="maximum" value="0"/>
93 <property name="message" value="Line has trailing spaces."/>
94 </module>
95
Madan Jampanic27b6b22016-02-05 11:36:31 -080096 <module name="RegexpMultiline">
97 <property name="format" value="\r\n"/>
98 <property name="maximum" value="0"/>
99 <property name="message" value="Line has windows line endings."/>
100 </module>
101
tom0eb04ca2014-08-25 14:34:51 -0700102 <!-- Checks for Headers -->
103 <!-- See http://checkstyle.sf.net/config_header.html -->
104 <!-- <module name="Header"> -->
105 <!-- <property name="headerFile" value="${checkstyle.header.file}"/> -->
106 <!-- <property name="fileExtensions" value="java"/> -->
107 <!-- </module> -->
108
Ray Milkey85267002016-11-16 11:06:35 -0800109 <module name="RegexpHeader">
110 <property name="headerFile" value="tools/build/conf/src/main/resources/onos/onos-java.header"/>
Ray Milkey2d572dd2017-04-14 10:01:24 -0700111 <property name="fileExtensions" value="java"/>
Ray Milkey85267002016-11-16 11:06:35 -0800112 </module>
113
114
tom0eb04ca2014-08-25 14:34:51 -0700115 <module name="SuppressionCommentFilter">
Brian O'Connor8b5edbc2016-04-05 15:45:25 -0700116 <property name="offCommentFormat"
117 value="(CHECKSTYLE\:OFF|Generated by the protocol buffer compiler.)"/>
tom0eb04ca2014-08-25 14:34:51 -0700118 <property name="onCommentFormat" value="CHECKSTYLE:ON"/>
119 </module>
120
121 <module name="SuppressWithNearbyCommentFilter">
Brian O'Connor8b5edbc2016-04-05 15:45:25 -0700122 <property name="commentFormat" value="CHECKSTYLE IGNORE THIS LINE"/>
123 <property name="checkFormat" value=".*"/>
124 <property name="influenceFormat" value="0"/>
tom0eb04ca2014-08-25 14:34:51 -0700125 </module>
126
127 <!-- Example: // CHECKSTYLE IGNORE FinalClass FOR NEXT 1 LINES -->
128 <module name="SuppressWithNearbyCommentFilter">
Brian O'Connor8b5edbc2016-04-05 15:45:25 -0700129 <property name="commentFormat"
130 value="CHECKSTYLE IGNORE (\w+) FOR NEXT (\d+) LINES"/>
tom0eb04ca2014-08-25 14:34:51 -0700131 <property name="checkFormat" value="$1"/>
132 <property name="influenceFormat" value="$2"/>
133 </module>
134
135 <module name="TreeWalker">
136
137 <module name="FileContentsHolder"/>
138 <!-- Checks for Javadoc comments. -->
139 <!-- See http://checkstyle.sf.net/config_javadoc.html -->
140 <module name="JavadocMethod">
Ray Milkey0bb1e102016-11-10 14:51:27 -0800141 <property name="scope" value="package"/>
Yuta HIGUCHI9312a802017-06-12 20:01:27 -0700142 <property name="allowMissingJavadoc" value="true"/>
tom0eb04ca2014-08-25 14:34:51 -0700143 <property name="allowUndeclaredRTE" value="true"/>
Yuta HIGUCHI9312a802017-06-12 20:01:27 -0700144 <property name="suppressLoadErrors" value="true"/>
tom0eb04ca2014-08-25 14:34:51 -0700145 </module>
146 <module name="JavadocType">
147 <property name="severity" value="warning"/>
148 </module>
149 <module name="JavadocVariable">
150 <!-- Suppress check for private member Javadocs.
151 Possibly revist fixing these. -->
152 <property name="scope" value="public"/>
153 <property name="severity" value="warning"/>
154 </module>
155 <module name="JavadocStyle"/>
Brian O'Connor8b5edbc2016-04-05 15:45:25 -0700156 <!-- @author tag should not be used -->
tom0eb04ca2014-08-25 14:34:51 -0700157 <module name="WriteTag">
158 <property name="tag" value="@author"/>
159 <property name="tagFormat" value="\S"/>
160 <property name="severity" value="ignore"/>
161 <property name="tagSeverity" value="error"/>
162 </module>
163
Jonathan Hart51539b82015-10-29 09:53:04 -0700164 <module name="AbbreviationAsWordInName">
Brian O'Connor8b5edbc2016-04-05 15:45:25 -0700165 <property name="allowedAbbreviationLength" value="2"/>
Jonathan Hart51539b82015-10-29 09:53:04 -0700166 </module>
tom0eb04ca2014-08-25 14:34:51 -0700167
168 <!-- Checks for Naming Conventions. -->
169 <!-- See http://checkstyle.sf.net/config_naming.html -->
170 <module name="ConstantName">
171 <!-- ONOS allows the name "log" for static final Loggers -->
172 <property name="format"
173 value="^log$|^[A-Z][A-Z0-9]*(_[A-Z0-9]+)*$"/>
174 </module>
175 <module name="LocalFinalVariableName"/>
176
177 <module name="LocalVariableName"/>
178
179 <module name="MemberName"/>
180 <module name="MethodName"/>
Jonathan Hart317f4762015-11-09 16:05:36 -0800181 <module name="PackageName">
182 <property name="format" value="^[a-z]+(\.[a-z][a-z0-9]*)*$"/>
183 </module>
tom0eb04ca2014-08-25 14:34:51 -0700184 <module name="ParameterName"/>
185 <module name="StaticVariableName"/>
186 <module name="TypeName"/>
187
188 <!-- Checks for imports -->
189 <!-- See http://checkstyle.sf.net/config_import.html -->
190 <module name="AvoidStarImport">
Brian O'Connor8b5edbc2016-04-05 15:45:25 -0700191 <property name="allowStaticMemberImports" value="true"/>
tom0eb04ca2014-08-25 14:34:51 -0700192 </module>
193 <module name="IllegalImport"/>
194 <!-- defaults to sun.* packages -->
195 <module name="RedundantImport"/>
196 <module name="UnusedImports"/>
197
198
199 <!-- Checks for Size Violations. -->
200 <!-- See http://checkstyle.sf.net/config_sizes.html -->
201 <module name="LineLength">
202 <!-- ONOS standard usage is 80 columns, but we allow up
203 to 120 to not break the build. -->
204 <property name="max" value="120"/>
205 <property name="ignorePattern" value="^import"/>
206 </module>
207 <module name="MethodLength">
208 <property name="max" value="200"/>
209 </module>
210
alshabib6b5cfec2014-09-18 17:42:18 -0700211 <module name="ParameterNumber">
alshabibba5ac482014-10-02 17:15:20 -0700212 <property name="max" value="15"/>
alshabib6b5cfec2014-09-18 17:42:18 -0700213 <property name="tokens" value="CTOR_DEF"/>
214 </module>
tom0eb04ca2014-08-25 14:34:51 -0700215 <!-- Checks for whitespace -->
216 <!-- See http://checkstyle.sf.net/config_whitespace.html -->
217 <module name="EmptyForIteratorPad"/>
218 <module name="GenericWhitespace"/>
219 <module name="MethodParamPad"/>
220 <module name="NoWhitespaceAfter"/>
221 <module name="NoWhitespaceBefore"/>
222
223 <!-- Disabled for ONOS. Default rules specify undesired behavior for the '?' operator -->
224 <!-- <module name="OperatorWrap"/> -->
225 <module name="ParenPad"/>
226 <module name="TypecastParenPad"/>
227 <module name="WhitespaceAfter"/>
228 <module name="WhitespaceAround">
229 <property name="allowEmptyConstructors" value="true"/>
230 <property name="allowEmptyMethods" value="true"/>
231 </module>
232
233
tom0eb04ca2014-08-25 14:34:51 -0700234 <!-- Modifier Checks -->
235 <!-- See http://checkstyle.sf.net/config_modifiers.html -->
236 <module name="ModifierOrder"/>
237
238 <!-- Disabled for ONOS to allow use of public -->
239 <!-- modifiers in interfaces. -->
240 <!-- <module name="RedundantModifier"/> -->
241
242
243 <!-- Checks for blocks. You know, those {}'s -->
244 <!-- See http://checkstyle.sf.net/config_blocks.html -->
245 <module name="AvoidNestedBlocks">
246 <!-- ONOS alows declarations inside of switch case blocks -->
247 <property name="allowInSwitchCase" value="true"/>
248 </module>
HIGUCHI Yuta94a9eed2015-09-25 15:20:04 -0700249 <module name="EmptyBlock">
250 <!-- allow empty block, as long as there's some comment -->
251 <property name="option" value="text"/>
252 </module>
tom0eb04ca2014-08-25 14:34:51 -0700253 <module name="LeftCurly"/>
254 <module name="NeedBraces"/>
255 <module name="RightCurly"/>
256
257 <!-- Checks for common coding problems -->
258 <!-- See http://checkstyle.sf.net/config_coding.html -->
259 <!-- ONOS allows conditional operators -->
260 <!-- <module name="AvoidInlineConditionals"/> -->
261 <module name="EmptyStatement"/>
262 <module name="EqualsHashCode"/>
263
264 <module name="HiddenField">
265 <property name="ignoreSetter" value="true"/>
266 <property name="ignoreConstructorParameter" value="true"/>
267 </module>
268
269 <module name="IllegalInstantiation"/>
270 <module name="InnerAssignment"/>
271
272 <!-- Many violations of this rule present, revist in a
273 subsequent round of cleanups -->
274 <!-- <module name="MagicNumber"/> -->
275 <module name="MissingSwitchDefault"/>
276
tom0eb04ca2014-08-25 14:34:51 -0700277 <module name="SimplifyBooleanExpression"/>
278 <module name="SimplifyBooleanReturn"/>
279
280 <!-- Checks for class design -->
281 <!-- See http://checkstyle.sf.net/config_design.html -->
282 <!-- ONOS produces many warnings of this type.
283 Fixing all of these is outside the scope of the current cleanup. -->
284 <!-- <module name="DesignForExtension"/> -->
285 <module name="FinalClass"/>
286
287 <module name="HideUtilityClassConstructor"/>
288
289 <module name="InterfaceIsType"/>
290
291 <module name="VisibilityModifier">
292 <property name="severity" value="warning"/>
293 </module>
294
295
tom0eb04ca2014-08-25 14:34:51 -0700296 <!-- Miscellaneous other checks. -->
297 <!-- See http://checkstyle.sf.net/config_misc.html -->
298 <module name="ArrayTypeStyle"/>
299
300 <!-- Many violations of this rule currently, too many to fix
301 in the current cleanup. -->
302 <!-- <module name="FinalParameters"/> -->
303 <!-- ONOS allows TODO markers in checked in source code -->
304 <!-- <module name="TodoComment"/> -->
305 <module name="UpperEll"/>
tom0eb04ca2014-08-25 14:34:51 -0700306 </module>
Brian O'Connor8b5edbc2016-04-05 15:45:25 -0700307
308</module>