blob: 5baa022d3a6782ba7d1a7c303e8d4f4a8ed697bb [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">
46 <!--
47 If you set the basedir property below, then all reported file
48 names will be relative to the specified directory. See
49 http://checkstyle.sourceforge.net/5.x/config.html#Checker
50
51 <property name="basedir" value="${basedir}"/>
52 -->
53 <!-- Checks that a package-info.java file exists for each package. -->
54 <!-- See http://checkstyle.sf.net/config_javadoc.html#JavadocPackage -->
55 <!-- ONOS does not currently supply package level Javadoc information
Ray Milkeyb5716c52014-04-07 11:38:27 -070056 in package-info files -->
Yuta HIGUCHIf9808442014-03-20 15:56:50 -070057 <!-- <module name="JavadocPackage"/> -->
58
59 <!-- Checks whether files end with a new line. -->
60 <!-- See http://checkstyle.sf.net/config_misc.html#NewlineAtEndOfFile -->
Ray Milkey0f913a02014-04-07 20:58:17 -070061 <module name="NewlineAtEndOfFile"/>
Yuta HIGUCHIf9808442014-03-20 15:56:50 -070062
63 <!-- Checks that property files contain the same keys. -->
64 <!-- See http://checkstyle.sf.net/config_misc.html#Translation -->
65 <module name="Translation"/>
Ray Milkey3f5ef562014-03-25 17:11:19 -070066
Yuta HIGUCHIf9808442014-03-20 15:56:50 -070067 <!-- Checks for Size Violations. -->
68 <!-- See http://checkstyle.sf.net/config_sizes.html -->
Ray Milkeyb5716c52014-04-07 11:38:27 -070069 <module name="FileLength">
70 <property name="severity" value="warning"/>
71 </module>
Ray Milkey3f5ef562014-03-25 17:11:19 -070072
Yuta HIGUCHIf9808442014-03-20 15:56:50 -070073 <!-- Checks for whitespace -->
74 <!-- See http://checkstyle.sf.net/config_whitespace.html -->
75 <module name="FileTabCharacter"/>
76
77 <!-- Miscellaneous other checks. -->
78 <!-- See http://checkstyle.sf.net/config_misc.html -->
79 <module name="RegexpSingleline">
Ray Milkey3f5ef562014-03-25 17:11:19 -070080 <property name="format" value="\s+$"/>
81 <property name="minimum" value="0"/>
82 <property name="maximum" value="0"/>
83 <property name="message" value="Line has trailing spaces."/>
Yuta HIGUCHIf9808442014-03-20 15:56:50 -070084 </module>
85
86 <!-- Checks for Headers -->
87 <!-- See http://checkstyle.sf.net/config_header.html -->
88 <!-- <module name="Header"> -->
89 <!-- <property name="headerFile" value="${checkstyle.header.file}"/> -->
90 <!-- <property name="fileExtensions" value="java"/> -->
91 <!-- </module> -->
92
93 <module name="TreeWalker">
94
95 <!-- Checks for Javadoc comments. -->
96 <!-- See http://checkstyle.sf.net/config_javadoc.html -->
Ray Milkeyb5716c52014-04-07 11:38:27 -070097 <module name="JavadocMethod">
98 <property name="severity" value="warning"/>
99 </module>
100 <module name="JavadocType">
101 <property name="severity" value="warning"/>
102 </module>
Yuta HIGUCHIf9808442014-03-20 15:56:50 -0700103 <module name="JavadocVariable">
Ray Milkey3f5ef562014-03-25 17:11:19 -0700104 <!-- Suppress check for private member Javadocs.
105 Possibly revist fixing these. -->
106 <property name="scope" value="public"/>
Ray Milkeyb5716c52014-04-07 11:38:27 -0700107 <property name="severity" value="warning"/>
Ray Milkey3f5ef562014-03-25 17:11:19 -0700108 </module>
Ray Milkeyb41100a2014-04-10 10:42:15 -0700109 <module name="JavadocStyle"/>
Yuta HIGUCHIf9808442014-03-20 15:56:50 -0700110
111
112 <!-- Checks for Naming Conventions. -->
113 <!-- See http://checkstyle.sf.net/config_naming.html -->
Ray Milkeyec497712014-03-20 17:51:22 -0700114 <module name="ConstantName">
Ray Milkey3f5ef562014-03-25 17:11:19 -0700115 <!-- ONOS allows the name "log" for static final Loggers -->
116 <property name="format"
117 value="^log$|^[A-Z][A-Z0-9]*(_[A-Z0-9]+)*$"/>
118 </module>
Yuta HIGUCHIf9808442014-03-20 15:56:50 -0700119 <module name="LocalFinalVariableName"/>
Yuta HIGUCHIf9808442014-03-20 15:56:50 -0700120
Ray Milkey2476cac2014-04-08 11:03:21 -0700121 <module name="LocalVariableName"/>
Ray Milkeyb5716c52014-04-07 11:38:27 -0700122
Ray Milkey2476cac2014-04-08 11:03:21 -0700123 <module name="MemberName"/>
Ray Milkeyb5716c52014-04-07 11:38:27 -0700124
125 <module name="MethodName">
126 <property name="severity" value="warning"/>
127 </module>
128
129 <module name="PackageName"/>
Ray Milkey9526d6f2014-04-10 14:54:15 -0700130 <module name="ParameterName"/>
Ray Milkey94b41b52014-04-10 11:13:06 -0700131 <module name="StaticVariableName"/>
Ray Milkeyb5716c52014-04-07 11:38:27 -0700132 <module name="TypeName"/>
Yuta HIGUCHIf9808442014-03-20 15:56:50 -0700133
134 <!-- Checks for imports -->
135 <!-- See http://checkstyle.sf.net/config_import.html -->
136 <module name="AvoidStarImport"/>
Ray Milkey3f5ef562014-03-25 17:11:19 -0700137 <module name="IllegalImport"/>
138 <!-- defaults to sun.* packages -->
Yuta HIGUCHIf9808442014-03-20 15:56:50 -0700139 <module name="RedundantImport"/>
140 <module name="UnusedImports"/>
141
142
143 <!-- Checks for Size Violations. -->
144 <!-- See http://checkstyle.sf.net/config_sizes.html -->
145 <module name="LineLength">
Ray Milkey3f5ef562014-03-25 17:11:19 -0700146 <!-- ONOS standard usage is 80 columns, but we allow up
147 to 120 to not break the build. -->
148 <property name="max" value="120"/>
Ray Milkeyb5716c52014-04-07 11:38:27 -0700149 <property name="severity" value="warning"/>
Yuta HIGUCHIf9808442014-03-20 15:56:50 -0700150 </module>
Ray Milkeyb5716c52014-04-07 11:38:27 -0700151 <module name="MethodLength">
152 <property name="severity" value="warning"/>
153 </module>
154
155 <module name="ParameterNumber">
156 <property name="severity" value="warning"/>
157 </module>
Yuta HIGUCHIf9808442014-03-20 15:56:50 -0700158
159
160 <!-- Checks for whitespace -->
161 <!-- See http://checkstyle.sf.net/config_whitespace.html -->
Ray Milkey7f1567c2014-04-08 13:53:32 -0700162 <module name="EmptyForIteratorPad"/>
Yuta HIGUCHIf9808442014-03-20 15:56:50 -0700163 <module name="GenericWhitespace"/>
164 <module name="MethodParamPad"/>
Ray Milkey7f1567c2014-04-08 13:53:32 -0700165 <module name="NoWhitespaceAfter"/>
166 <module name="NoWhitespaceBefore"/>
Ray Milkeyb5716c52014-04-07 11:38:27 -0700167
Ray Milkey3f5ef562014-03-25 17:11:19 -0700168 <!-- Disabled for ONOS. Default rules specify undesired behavior for the '?' operator -->
Yuta HIGUCHIf9808442014-03-20 15:56:50 -0700169 <!-- <module name="OperatorWrap"/> -->
170 <module name="ParenPad"/>
171 <module name="TypecastParenPad"/>
Ray Milkey7f1567c2014-04-08 13:53:32 -0700172 <module name="WhitespaceAfter"/>
173 <module name="WhitespaceAround"/>
Ray Milkeyb5716c52014-04-07 11:38:27 -0700174
Yuta HIGUCHIf9808442014-03-20 15:56:50 -0700175
176
177 <!-- Modifier Checks -->
178 <!-- See http://checkstyle.sf.net/config_modifiers.html -->
Ray Milkeyec838942014-04-09 11:28:43 -0700179 <module name="ModifierOrder"/>
Ray Milkeyb5716c52014-04-07 11:38:27 -0700180
Ray Milkey3f5ef562014-03-25 17:11:19 -0700181 <!-- Disabled for ONOS to allow use of public -->
182 <!-- modifiers in interfaces. -->
183 <!-- <module name="RedundantModifier"/> -->
Yuta HIGUCHIf9808442014-03-20 15:56:50 -0700184
185
186 <!-- Checks for blocks. You know, those {}'s -->
187 <!-- See http://checkstyle.sf.net/config_blocks.html -->
188 <module name="AvoidNestedBlocks">
Ray Milkey3f5ef562014-03-25 17:11:19 -0700189 <!-- ONOS alows declarations inside of switch case blocks -->
Yuta HIGUCHIf9808442014-03-20 15:56:50 -0700190 <property name="allowInSwitchCase" value="true"/>
Yuta HIGUCHIf9808442014-03-20 15:56:50 -0700191 </module>
Ray Milkey1aa71f82014-04-08 16:23:24 -0700192 <module name="EmptyBlock"/>
Ray Milkeyb5716c52014-04-07 11:38:27 -0700193 <module name="LeftCurly"/>
Ray Milkeyb29e6262014-04-09 16:02:14 -0700194 <module name="NeedBraces"/>
Ray Milkeyb5716c52014-04-07 11:38:27 -0700195 <module name="RightCurly"/>
Yuta HIGUCHIf9808442014-03-20 15:56:50 -0700196
197 <!-- Checks for common coding problems -->
198 <!-- See http://checkstyle.sf.net/config_coding.html -->
Ray Milkey3f5ef562014-03-25 17:11:19 -0700199 <!-- ONOS allows conditional operators -->
Yuta HIGUCHIf9808442014-03-20 15:56:50 -0700200 <!-- <module name="AvoidInlineConditionals"/> -->
Ray Milkey043daa22014-04-08 14:13:16 -0700201 <module name="EmptyStatement"/>
Yuta HIGUCHIf9808442014-03-20 15:56:50 -0700202 <module name="EqualsHashCode"/>
Ray Milkeyb5716c52014-04-07 11:38:27 -0700203
204 <module name="HiddenField">
205 <property name="severity" value="warning"/>
206 </module>
207
Yuta HIGUCHIf9808442014-03-20 15:56:50 -0700208 <module name="IllegalInstantiation"/>
Ray Milkeyb6e0ac82014-04-09 13:21:42 -0700209 <module name="InnerAssignment"/>
Ray Milkeyb5716c52014-04-07 11:38:27 -0700210
Ray Milkey3f5ef562014-03-25 17:11:19 -0700211 <!-- Many violations of this rule present, revist in a
212 subsequent round of cleanups -->
Yuta HIGUCHIf9808442014-03-20 15:56:50 -0700213 <!-- <module name="MagicNumber"/> -->
Ray Milkeyb5716c52014-04-07 11:38:27 -0700214 <module name="MissingSwitchDefault">
215 <property name="severity" value="warning"/>
216 </module>
217
218 <module name="RedundantThrows">
219 <property name="severity" value="warning"/>
220 </module>
221
222 <module name="SimplifyBooleanExpression">
223 <property name="severity" value="warning"/>
224 </module>
225
226 <module name="SimplifyBooleanReturn">
227 <property name="severity" value="warning"/>
228 </module>
229
Yuta HIGUCHIf9808442014-03-20 15:56:50 -0700230
231 <!-- Checks for class design -->
232 <!-- See http://checkstyle.sf.net/config_design.html -->
Ray Milkey3f5ef562014-03-25 17:11:19 -0700233 <!-- ONOS produces many warnings of this type.
234 Fixing all of these is outside the scope of the current cleanup. -->
Yuta HIGUCHIf9808442014-03-20 15:56:50 -0700235 <!-- <module name="DesignForExtension"/> -->
Ray Milkey1584ec82014-04-10 11:58:30 -0700236 <module name="FinalClass"/>
Ray Milkeyb5716c52014-04-07 11:38:27 -0700237
Ray Milkeya2e21462014-04-10 13:21:44 -0700238 <module name="HideUtilityClassConstructor"/>
Ray Milkeyb5716c52014-04-07 11:38:27 -0700239
Yuta HIGUCHIf9808442014-03-20 15:56:50 -0700240 <module name="InterfaceIsType"/>
Ray Milkeyb5716c52014-04-07 11:38:27 -0700241
242 <module name="VisibilityModifier">
243 <property name="severity" value="warning"/>
244 </module>
245
Yuta HIGUCHIf9808442014-03-20 15:56:50 -0700246
247
248 <!-- Miscellaneous other checks. -->
249 <!-- See http://checkstyle.sf.net/config_misc.html -->
Ray Milkey45614c52014-04-07 16:30:54 -0700250 <module name="ArrayTypeStyle"/>
Ray Milkeyb5716c52014-04-07 11:38:27 -0700251
Ray Milkey3f5ef562014-03-25 17:11:19 -0700252 <!-- Many violations of this rule currently, too many to fix
253 in the current cleanup. -->
Yuta HIGUCHIf9808442014-03-20 15:56:50 -0700254 <!-- <module name="FinalParameters"/> -->
Ray Milkey3f5ef562014-03-25 17:11:19 -0700255 <!-- ONOS allows TODO markers in checked in source code -->
Yuta HIGUCHIf9808442014-03-20 15:56:50 -0700256 <!-- <module name="TodoComment"/> -->
257 <module name="UpperEll"/>
258
Ray Milkeyb5716c52014-04-07 11:38:27 -0700259 </module>
Yuta HIGUCHIf9808442014-03-20 15:56:50 -0700260
Ray Milkeyb5716c52014-04-07 11:38:27 -0700261 </module>