blob: b2011e46981330a320b0d7d07c52b5c588e7f79c [file] [log] [blame]
Yuta HIGUCHIf9808442014-03-20 15:56:50 -07001<?xml version="1.0"?>
2<!DOCTYPE module PUBLIC
Ray Milkey3f5ef562014-03-25 17:11:19 -07003 "-//Puppy Crawl//DTD Check Configuration 1.3//EN"
4 "http://www.puppycrawl.com/dtds/configuration_1_3.dtd">
Yuta HIGUCHIf9808442014-03-20 15:56:50 -07005
6
7<!--
8
9 Checkstyle configuration that checks the sun coding conventions from:
10
11 - the Java Language Specification at
12 http://java.sun.com/docs/books/jls/second_edition/html/index.html
13
14 - the Sun Code Conventions at http://java.sun.com/docs/codeconv/
15
16 - the Javadoc guidelines at
17 http://java.sun.com/j2se/javadoc/writingdoccomments/index.html
18
19 - the JDK Api documentation http://java.sun.com/j2se/docs/api/index.html
20
21 - some best practices
22
23 Checkstyle is very configurable. Be sure to read the documentation at
24 http://checkstyle.sf.net (or in your downloaded distribution).
25
26 Most Checks are configurable, be sure to consult the documentation.
27
28 To completely disable a check, just comment it out or delete it from the file.
29
30 Finally, it is worth reading the documentation.
31
32-->
33
Ray Milkeyb5716c52014-04-07 11:38:27 -070034
35<!--
36 The default severity setting in checkstyle is 'error', so some
37 of the rules below are configured to change the severity to
38 'warning'. Over time, these 'warning' settings should be
39 removed as more of the ONOS source code is modified to
40 follow the recommended rules.
41-->
42
43
44
Yuta HIGUCHIf9808442014-03-20 15:56:50 -070045<module name="Checker">
Yuta HIGUCHIcbbaed32014-05-14 20:27:43 -070046 <module name="SuppressionFilter">
47 <property name="file" value="${config_loc}/onos_suppressions.xml"/>
48 </module>
Yuta HIGUCHIf9808442014-03-20 15:56:50 -070049 <!--
50 If you set the basedir property below, then all reported file
51 names will be relative to the specified directory. See
52 http://checkstyle.sourceforge.net/5.x/config.html#Checker
53
54 <property name="basedir" value="${basedir}"/>
55 -->
56 <!-- Checks that a package-info.java file exists for each package. -->
57 <!-- See http://checkstyle.sf.net/config_javadoc.html#JavadocPackage -->
58 <!-- ONOS does not currently supply package level Javadoc information
Ray Milkeyb5716c52014-04-07 11:38:27 -070059 in package-info files -->
Yuta HIGUCHIf9808442014-03-20 15:56:50 -070060 <!-- <module name="JavadocPackage"/> -->
61
62 <!-- Checks whether files end with a new line. -->
63 <!-- See http://checkstyle.sf.net/config_misc.html#NewlineAtEndOfFile -->
Ray Milkey0f913a02014-04-07 20:58:17 -070064 <module name="NewlineAtEndOfFile"/>
Yuta HIGUCHIf9808442014-03-20 15:56:50 -070065
66 <!-- Checks that property files contain the same keys. -->
67 <!-- See http://checkstyle.sf.net/config_misc.html#Translation -->
68 <module name="Translation"/>
Ray Milkey3f5ef562014-03-25 17:11:19 -070069
Yuta HIGUCHIf9808442014-03-20 15:56:50 -070070 <!-- Checks for Size Violations. -->
71 <!-- See http://checkstyle.sf.net/config_sizes.html -->
Ray Milkey0b122ed2014-04-14 10:06:03 -070072 <module name="FileLength"/>
Ray Milkey3f5ef562014-03-25 17:11:19 -070073
Yuta HIGUCHIf9808442014-03-20 15:56:50 -070074 <!-- Checks for whitespace -->
75 <!-- See http://checkstyle.sf.net/config_whitespace.html -->
76 <module name="FileTabCharacter"/>
77
78 <!-- Miscellaneous other checks. -->
79 <!-- See http://checkstyle.sf.net/config_misc.html -->
80 <module name="RegexpSingleline">
Ray Milkey3f5ef562014-03-25 17:11:19 -070081 <property name="format" value="\s+$"/>
82 <property name="minimum" value="0"/>
83 <property name="maximum" value="0"/>
84 <property name="message" value="Line has trailing spaces."/>
Yuta HIGUCHIf9808442014-03-20 15:56:50 -070085 </module>
86
87 <!-- Checks for Headers -->
88 <!-- See http://checkstyle.sf.net/config_header.html -->
89 <!-- <module name="Header"> -->
90 <!-- <property name="headerFile" value="${checkstyle.header.file}"/> -->
91 <!-- <property name="fileExtensions" value="java"/> -->
92 <!-- </module> -->
93
Ray Milkey5df613b2014-04-15 10:50:56 -070094 <module name="SuppressionCommentFilter">
Yuta HIGUCHIa4d51d42014-06-19 17:54:09 -070095 <property name="offCommentFormat" value="(CHECKSTYLE\:OFF|Generated by the protocol buffer compiler.)"/>
Ray Milkey098466c2014-04-22 11:36:46 -070096 <property name="onCommentFormat" value="CHECKSTYLE:ON"/>
Ray Milkey5df613b2014-04-15 10:50:56 -070097 </module>
Yuta HIGUCHI5dc86642014-06-25 14:13:45 -070098
99 <module name="SuppressWithNearbyCommentFilter">
100 <property name="commentFormat" value="CHECKSTYLE IGNORE THIS LINE" />
101 <property name="checkFormat" value=".*" />
102 <property name="influenceFormat" value="0" />
103 </module>
104
105 <!-- Example: // CHECKSTYLE IGNORE FinalClass FOR NEXT 1 LINES -->
106 <module name="SuppressWithNearbyCommentFilter">
107 <property name="commentFormat" value="CHECKSTYLE IGNORE (\w+) FOR NEXT (\d+) LINES"/>
108 <property name="checkFormat" value="$1"/>
109 <property name="influenceFormat" value="$2"/>
110 </module>
111
Yuta HIGUCHIf9808442014-03-20 15:56:50 -0700112 <module name="TreeWalker">
113
Ray Milkey5df613b2014-04-15 10:50:56 -0700114 <module name="FileContentsHolder"/>
Yuta HIGUCHIf9808442014-03-20 15:56:50 -0700115 <!-- Checks for Javadoc comments. -->
116 <!-- See http://checkstyle.sf.net/config_javadoc.html -->
Ray Milkeyb5716c52014-04-07 11:38:27 -0700117 <module name="JavadocMethod">
Ray Milkey098466c2014-04-22 11:36:46 -0700118 <property name="severity" value="warning"/>
Ray Milkeyb5716c52014-04-07 11:38:27 -0700119 </module>
120 <module name="JavadocType">
Ray Milkey098466c2014-04-22 11:36:46 -0700121 <property name="severity" value="warning"/>
Ray Milkeyb5716c52014-04-07 11:38:27 -0700122 </module>
Yuta HIGUCHIf9808442014-03-20 15:56:50 -0700123 <module name="JavadocVariable">
Ray Milkey3f5ef562014-03-25 17:11:19 -0700124 <!-- Suppress check for private member Javadocs.
125 Possibly revist fixing these. -->
126 <property name="scope" value="public"/>
Ray Milkeyb5716c52014-04-07 11:38:27 -0700127 <property name="severity" value="warning"/>
Ray Milkey3f5ef562014-03-25 17:11:19 -0700128 </module>
Ray Milkeyb41100a2014-04-10 10:42:15 -0700129 <module name="JavadocStyle"/>
Yuta HIGUCHIaa132f52014-06-26 10:18:39 -0700130 <!-- @author tag should not be used -->
131 <module name="WriteTag">
132 <property name="tag" value="@author"/>
133 <property name="tagFormat" value="\S"/>
134 <property name="severity" value="ignore"/>
135 <property name="tagSeverity" value="error"/>
136 </module>
137
Yuta HIGUCHIf9808442014-03-20 15:56:50 -0700138
Yuta HIGUCHIf9808442014-03-20 15:56:50 -0700139 <!-- Checks for Naming Conventions. -->
140 <!-- See http://checkstyle.sf.net/config_naming.html -->
Ray Milkeyec497712014-03-20 17:51:22 -0700141 <module name="ConstantName">
Ray Milkey3f5ef562014-03-25 17:11:19 -0700142 <!-- ONOS allows the name "log" for static final Loggers -->
143 <property name="format"
144 value="^log$|^[A-Z][A-Z0-9]*(_[A-Z0-9]+)*$"/>
145 </module>
Yuta HIGUCHIf9808442014-03-20 15:56:50 -0700146 <module name="LocalFinalVariableName"/>
Yuta HIGUCHIf9808442014-03-20 15:56:50 -0700147
Ray Milkey2476cac2014-04-08 11:03:21 -0700148 <module name="LocalVariableName"/>
Ray Milkeyb5716c52014-04-07 11:38:27 -0700149
Ray Milkey2476cac2014-04-08 11:03:21 -0700150 <module name="MemberName"/>
Ray Milkey7531a342014-04-11 15:08:12 -0700151 <module name="MethodName"/>
Ray Milkeyb5716c52014-04-07 11:38:27 -0700152 <module name="PackageName"/>
Ray Milkey9526d6f2014-04-10 14:54:15 -0700153 <module name="ParameterName"/>
Ray Milkey94b41b52014-04-10 11:13:06 -0700154 <module name="StaticVariableName"/>
Ray Milkeyb5716c52014-04-07 11:38:27 -0700155 <module name="TypeName"/>
Yuta HIGUCHIf9808442014-03-20 15:56:50 -0700156
157 <!-- Checks for imports -->
158 <!-- See http://checkstyle.sf.net/config_import.html -->
Yuta HIGUCHI91a8f502014-06-17 10:15:29 -0700159 <module name="AvoidStarImport">
160 <property name="allowStaticMemberImports" value="true"/>
161 </module>
Ray Milkey3f5ef562014-03-25 17:11:19 -0700162 <module name="IllegalImport"/>
163 <!-- defaults to sun.* packages -->
Yuta HIGUCHIf9808442014-03-20 15:56:50 -0700164 <module name="RedundantImport"/>
165 <module name="UnusedImports"/>
166
167
168 <!-- Checks for Size Violations. -->
169 <!-- See http://checkstyle.sf.net/config_sizes.html -->
170 <module name="LineLength">
Ray Milkey3f5ef562014-03-25 17:11:19 -0700171 <!-- ONOS standard usage is 80 columns, but we allow up
172 to 120 to not break the build. -->
173 <property name="max" value="120"/>
Yuta HIGUCHI927a3fe2014-06-11 22:14:43 -0700174 <property name="ignorePattern" value="^import"/>
Yuta HIGUCHIf9808442014-03-20 15:56:50 -0700175 </module>
Ray Milkeyb5716c52014-04-07 11:38:27 -0700176 <module name="MethodLength">
Ray Milkey098466c2014-04-22 11:36:46 -0700177 <property name="max" value="200"/>
178 </module>
Ray Milkeyb5716c52014-04-07 11:38:27 -0700179
Ray Milkeya5450cc2014-04-17 14:31:30 -0700180 <module name="ParameterNumber"/>
Yuta HIGUCHIf9808442014-03-20 15:56:50 -0700181
182 <!-- Checks for whitespace -->
183 <!-- See http://checkstyle.sf.net/config_whitespace.html -->
Ray Milkey7f1567c2014-04-08 13:53:32 -0700184 <module name="EmptyForIteratorPad"/>
Yuta HIGUCHIf9808442014-03-20 15:56:50 -0700185 <module name="GenericWhitespace"/>
186 <module name="MethodParamPad"/>
Ray Milkey7f1567c2014-04-08 13:53:32 -0700187 <module name="NoWhitespaceAfter"/>
188 <module name="NoWhitespaceBefore"/>
Ray Milkeyb5716c52014-04-07 11:38:27 -0700189
Ray Milkey3f5ef562014-03-25 17:11:19 -0700190 <!-- Disabled for ONOS. Default rules specify undesired behavior for the '?' operator -->
Yuta HIGUCHIf9808442014-03-20 15:56:50 -0700191 <!-- <module name="OperatorWrap"/> -->
192 <module name="ParenPad"/>
193 <module name="TypecastParenPad"/>
Ray Milkey7f1567c2014-04-08 13:53:32 -0700194 <module name="WhitespaceAfter"/>
Yuta HIGUCHI5a3e2cf2014-05-20 10:46:35 -0700195 <module name="WhitespaceAround">
196 <property name="allowEmptyConstructors" value="true"/>
197 <property name="allowEmptyMethods" value="true"/>
198 </module>
Ray Milkeyb5716c52014-04-07 11:38:27 -0700199
Yuta HIGUCHIf9808442014-03-20 15:56:50 -0700200
201
202 <!-- Modifier Checks -->
203 <!-- See http://checkstyle.sf.net/config_modifiers.html -->
Ray Milkeyec838942014-04-09 11:28:43 -0700204 <module name="ModifierOrder"/>
Ray Milkeyb5716c52014-04-07 11:38:27 -0700205
Ray Milkey3f5ef562014-03-25 17:11:19 -0700206 <!-- Disabled for ONOS to allow use of public -->
207 <!-- modifiers in interfaces. -->
208 <!-- <module name="RedundantModifier"/> -->
Yuta HIGUCHIf9808442014-03-20 15:56:50 -0700209
210
211 <!-- Checks for blocks. You know, those {}'s -->
212 <!-- See http://checkstyle.sf.net/config_blocks.html -->
213 <module name="AvoidNestedBlocks">
Ray Milkey3f5ef562014-03-25 17:11:19 -0700214 <!-- ONOS alows declarations inside of switch case blocks -->
Yuta HIGUCHIf9808442014-03-20 15:56:50 -0700215 <property name="allowInSwitchCase" value="true"/>
Yuta HIGUCHIf9808442014-03-20 15:56:50 -0700216 </module>
Ray Milkey1aa71f82014-04-08 16:23:24 -0700217 <module name="EmptyBlock"/>
Ray Milkeyb5716c52014-04-07 11:38:27 -0700218 <module name="LeftCurly"/>
Ray Milkeyb29e6262014-04-09 16:02:14 -0700219 <module name="NeedBraces"/>
Ray Milkeyb5716c52014-04-07 11:38:27 -0700220 <module name="RightCurly"/>
Yuta HIGUCHIf9808442014-03-20 15:56:50 -0700221
222 <!-- Checks for common coding problems -->
223 <!-- See http://checkstyle.sf.net/config_coding.html -->
Ray Milkey3f5ef562014-03-25 17:11:19 -0700224 <!-- ONOS allows conditional operators -->
Yuta HIGUCHIf9808442014-03-20 15:56:50 -0700225 <!-- <module name="AvoidInlineConditionals"/> -->
Ray Milkey043daa22014-04-08 14:13:16 -0700226 <module name="EmptyStatement"/>
Yuta HIGUCHIf9808442014-03-20 15:56:50 -0700227 <module name="EqualsHashCode"/>
Ray Milkeyb5716c52014-04-07 11:38:27 -0700228
229 <module name="HiddenField">
Ray Milkey098466c2014-04-22 11:36:46 -0700230 <property name="ignoreSetter" value="true"/>
231 <property name="ignoreConstructorParameter" value="true"/>
Ray Milkeyb5716c52014-04-07 11:38:27 -0700232 </module>
233
Yuta HIGUCHIf9808442014-03-20 15:56:50 -0700234 <module name="IllegalInstantiation"/>
Ray Milkeyb6e0ac82014-04-09 13:21:42 -0700235 <module name="InnerAssignment"/>
Ray Milkeyb5716c52014-04-07 11:38:27 -0700236
Ray Milkey3f5ef562014-03-25 17:11:19 -0700237 <!-- Many violations of this rule present, revist in a
238 subsequent round of cleanups -->
Yuta HIGUCHIf9808442014-03-20 15:56:50 -0700239 <!-- <module name="MagicNumber"/> -->
Ray Milkey0b122ed2014-04-14 10:06:03 -0700240 <module name="MissingSwitchDefault"/>
Ray Milkeyb5716c52014-04-07 11:38:27 -0700241
242 <module name="RedundantThrows">
Ray Milkey098466c2014-04-22 11:36:46 -0700243 <property name="allowSubclasses" value="true"/>
244 </module>
Ray Milkeyb5716c52014-04-07 11:38:27 -0700245
Ray Milkey6c4f2fe2014-04-11 09:47:23 -0700246 <module name="SimplifyBooleanExpression"/>
Ray Milkey4985f212014-04-10 16:57:05 -0700247 <module name="SimplifyBooleanReturn"/>
Yuta HIGUCHIf9808442014-03-20 15:56:50 -0700248
249 <!-- Checks for class design -->
250 <!-- See http://checkstyle.sf.net/config_design.html -->
Ray Milkey3f5ef562014-03-25 17:11:19 -0700251 <!-- ONOS produces many warnings of this type.
252 Fixing all of these is outside the scope of the current cleanup. -->
Yuta HIGUCHIf9808442014-03-20 15:56:50 -0700253 <!-- <module name="DesignForExtension"/> -->
Ray Milkey1584ec82014-04-10 11:58:30 -0700254 <module name="FinalClass"/>
Ray Milkeyb5716c52014-04-07 11:38:27 -0700255
Ray Milkeya2e21462014-04-10 13:21:44 -0700256 <module name="HideUtilityClassConstructor"/>
Ray Milkeyb5716c52014-04-07 11:38:27 -0700257
Yuta HIGUCHIf9808442014-03-20 15:56:50 -0700258 <module name="InterfaceIsType"/>
Ray Milkeyb5716c52014-04-07 11:38:27 -0700259
260 <module name="VisibilityModifier">
Ray Milkey098466c2014-04-22 11:36:46 -0700261 <property name="severity" value="warning"/>
Ray Milkeyb5716c52014-04-07 11:38:27 -0700262 </module>
263
Yuta HIGUCHIf9808442014-03-20 15:56:50 -0700264
265
266 <!-- Miscellaneous other checks. -->
267 <!-- See http://checkstyle.sf.net/config_misc.html -->
Ray Milkey45614c52014-04-07 16:30:54 -0700268 <module name="ArrayTypeStyle"/>
Ray Milkeyb5716c52014-04-07 11:38:27 -0700269
Ray Milkey3f5ef562014-03-25 17:11:19 -0700270 <!-- Many violations of this rule currently, too many to fix
271 in the current cleanup. -->
Yuta HIGUCHIf9808442014-03-20 15:56:50 -0700272 <!-- <module name="FinalParameters"/> -->
Ray Milkey3f5ef562014-03-25 17:11:19 -0700273 <!-- ONOS allows TODO markers in checked in source code -->
Yuta HIGUCHIf9808442014-03-20 15:56:50 -0700274 <!-- <module name="TodoComment"/> -->
275 <module name="UpperEll"/>
276
Ray Milkeyb5716c52014-04-07 11:38:27 -0700277 </module>
Yuta HIGUCHIf9808442014-03-20 15:56:50 -0700278
Ray Milkeyb5716c52014-04-07 11:38:27 -0700279 </module>