.checkstyle_checks.xml revision 12657:6ef01bd40ce2 
1<?xml version="1.0" encoding="UTF-8"?>
2<!DOCTYPE module PUBLIC "-//Puppy Crawl//DTD Check Configuration 1.3//EN" "http://www.puppycrawl.com/dtds/configuration_1_3.dtd">
3
4<!--
5    Checkstyle-Configuration: Checks
6    Description: none
7-->
8<module name="Checker">
9  <property name="severity" value="error"/>
10  <module name="TreeWalker">
11    <property name="tabWidth" value="4"/>
12    <module name="FileContentsHolder"/>
13    <module name="JavadocStyle">
14      <property name="checkHtml" value="false"/>
15    </module>
16    <module name="LocalFinalVariableName"/>
17    <module name="LocalVariableName"/>
18    <module name="MemberName">
19      <property name="format" value="^(([a-z][a-zA-Z0-9]*$)|(_[A-Z][a-zA-Z0-9]*_[a-z][a-zA-Z0-9]*$))"/>
20    </module>
21    <module name="MethodName"/>
22    <module name="PackageName"/>
23    <module name="ParameterName"/>
24    <module name="TypeName">
25      <property name="format" value="^[A-Z][_a-zA-Z0-9]*$"/>
26    </module>
27    <module name="RedundantImport"/>
28    <module name="LineLength">
29      <property name="max" value="250"/>
30    </module>
31    <module name="MethodParamPad"/>
32    <module name="NoWhitespaceAfter">
33      <property name="tokens" value="ARRAY_INIT,BNOT,DEC,DOT,INC,LNOT,UNARY_MINUS,UNARY_PLUS"/>
34    </module>
35    <module name="AvoidStarImport">
36       <property name="allowClassImports" value="false"/>
37       <property name="allowStaticMemberImports" value="false"/>
38    </module>
39    <module name="NoWhitespaceBefore">
40      <property name="tokens" value="SEMI,DOT,POST_DEC,POST_INC"/>
41    </module>
42    <module name="ParenPad"/>
43    <module name="TypecastParenPad">
44      <property name="tokens" value="RPAREN,TYPECAST"/>
45    </module>
46    <module name="WhitespaceAfter"/>
47    <module name="WhitespaceAround">
48      <property name="tokens" value="ASSIGN,BAND,BAND_ASSIGN,BOR,BOR_ASSIGN,BSR,BSR_ASSIGN,BXOR,BXOR_ASSIGN,COLON,DIV,DIV_ASSIGN,EQUAL,GE,GT,LAND,LE,LITERAL_ASSERT,LITERAL_CATCH,LITERAL_DO,LITERAL_ELSE,LITERAL_FINALLY,LITERAL_FOR,LITERAL_IF,LITERAL_RETURN,LITERAL_SYNCHRONIZED,LITERAL_TRY,LITERAL_WHILE,LOR,LT,MINUS,MINUS_ASSIGN,MOD,MOD_ASSIGN,NOT_EQUAL,PLUS,PLUS_ASSIGN,QUESTION,SL,SLIST,SL_ASSIGN,SR,SR_ASSIGN,STAR,STAR_ASSIGN,LITERAL_ASSERT,TYPE_EXTENSION_AND"/>
49    </module>
50    <module name="RedundantModifier"/>
51    <module name="AvoidNestedBlocks">
52      <property name="allowInSwitchCase" value="true"/>
53    </module>
54    <module name="EmptyBlock">
55      <property name="option" value="text"/>
56      <property name="tokens" value="LITERAL_DO,LITERAL_ELSE,LITERAL_FINALLY,LITERAL_IF,LITERAL_TRY,LITERAL_WHILE,STATIC_INIT"/>
57    </module>
58    <module name="LeftCurly"/>
59    <module name="NeedBraces"/>
60    <module name="RightCurly"/>
61    <module name="EmptyStatement"/>
62    <module name="HiddenField">
63      <property name="severity" value="ignore"/>
64      <property name="ignoreConstructorParameter" value="true"/>
65      <metadata name="net.sf.eclipsecs.core.lastEnabledSeverity" value="inherit"/>
66    </module>
67    <module name="FinalClass"/>
68    <module name="HideUtilityClassConstructor">
69      <property name="severity" value="ignore"/>
70      <metadata name="net.sf.eclipsecs.core.lastEnabledSeverity" value="inherit"/>
71    </module>
72    <module name="ArrayTypeStyle"/>
73    <module name="UpperEll"/>
74    <module name="FallThrough"/>
75    <module name="FinalLocalVariable">
76      <property name="severity" value="ignore"/>
77      <metadata name="net.sf.eclipsecs.core.lastEnabledSeverity" value="inherit"/>
78    </module>
79    <module name="MultipleVariableDeclarations"/>
80    <module name="StringLiteralEquality">
81      <property name="severity" value="error"/>
82    </module>
83    <module name="SuperFinalize"/>
84    <module name="UnnecessaryParentheses">
85      <property name="severity" value="ignore"/>
86      <metadata name="net.sf.eclipsecs.core.lastEnabledSeverity" value="inherit"/>
87    </module>
88    <module name="Indentation">
89      <property name="severity" value="ignore"/>
90      <metadata name="net.sf.eclipsecs.core.lastEnabledSeverity" value="inherit"/>
91    </module>
92    <module name="StaticVariableName">
93      <property name="format" value="^[A-Za-z][a-zA-Z0-9]*$"/>
94    </module>
95    <module name="EmptyForInitializerPad"/>
96    <module name="EmptyForIteratorPad"/>
97    <module name="ModifierOrder"/>
98    <module name="DefaultComesLast"/>
99    <module name="InnerAssignment">
100      <property name="severity" value="ignore"/>
101      <metadata name="net.sf.eclipsecs.core.lastEnabledSeverity" value="inherit"/>
102    </module>
103    <module name="ModifiedControlVariable"/>
104    <module name="MutableException">
105      <property name="severity" value="ignore"/>
106      <metadata name="net.sf.eclipsecs.core.lastEnabledSeverity" value="inherit"/>
107    </module>
108    <module name="ParameterAssignment">
109      <property name="severity" value="ignore"/>
110      <metadata name="net.sf.eclipsecs.core.lastEnabledSeverity" value="inherit"/>
111    </module>
112    <module name="RegexpSinglelineJava">
113      <metadata name="net.sf.eclipsecs.core.comment" value="Illegal trailing whitespace(s) at the end of the line."/>
114      <property name="format" value="\s$"/>
115      <property name="message" value="Illegal trailing whitespace(s) at the end of the line."/>
116      <property name="ignoreComments" value="true"/>
117      <metadata name="com.atlassw.tools.eclipse.checkstyle.comment" value="Checks for trailing spaces at the end of a line"/>
118    </module>
119    <module name="RegexpSinglelineJava">
120      <metadata name="net.sf.eclipsecs.core.comment" value="illegal space before a comma"/>
121      <property name="format" value=" ,"/>
122      <property name="message" value="illegal space before a comma"/>
123      <property name="ignoreComments" value="true"/>
124      <metadata name="com.atlassw.tools.eclipse.checkstyle.comment" value="Checks for whitespace before a comma."/>
125      <metadata name="com.atlassw.tools.eclipse.checkstyle.customMessage" value="Illegal whitespace before a comma."/>
126    </module>
127    <module name="RegexpSinglelineJava">
128      <property name="format" value="[^\x00-\x7F]"/>
129      <property name="message" value="Only use ASCII characters."/>
130    </module>
131    <module name="RegexpSinglelineJava">
132      <property name="format" value="new (Hashtable|Vector|Stack|StringBuffer)[^\w]"/>
133      <property name="message" value="Don't use old synchronized collection classes"/>
134    </module>
135  </module>
136  <module name="RegexpHeader">
137    <property name="header" value="/\*\n \* Copyright \(c\) (20[0-9][0-9], )?20[0-9][0-9], Oracle and/or its affiliates. All rights reserved.\n \* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.\n \*\n \* This code is free software; you can redistribute it and/or modify it\n \* under the terms of the GNU General Public License version 2 only, as\n \* published by the Free Software Foundation.\n \*\n \* This code is distributed in the hope that it will be useful, but WITHOUT\n \* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\n \* FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License\n \* version 2 for more details \(a copy is included in the LICENSE file that\n \* accompanied this code\).\n \*\n \* You should have received a copy of the GNU General Public License version\n \* 2 along with this work; if not, write to the Free Software Foundation,\n \* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.\n \*\n \* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA\n \* or visit www.oracle.com if you need additional information or have any\n \* questions.\n \*/\n"/>
138    <property name="fileExtensions" value="java"/>
139  </module>
140  <module name="FileTabCharacter">
141    <property name="severity" value="error"/>
142    <property name="fileExtensions" value="java"/>
143  </module>
144  <module name="NewlineAtEndOfFile">
145    <property name="lineSeparator" value="lf"/>
146  </module>
147  <module name="Translation"/>
148  <module name="SuppressionCommentFilter">
149    <property name="offCommentFormat" value="Checkstyle: stop constant name check"/>
150    <property name="onCommentFormat" value="Checkstyle: resume constant name check"/>
151    <property name="checkFormat" value="ConstantNameCheck"/>
152    <metadata name="com.atlassw.tools.eclipse.checkstyle.comment" value="Allow non-conforming constant names"/>
153  </module>
154  <module name="SuppressionCommentFilter">
155    <property name="offCommentFormat" value="Checkstyle: stop method name check"/>
156    <property name="onCommentFormat" value="Checkstyle: resume method name check"/>
157    <property name="checkFormat" value="MethodName"/>
158    <property name="checkC" value="false"/>
159    <metadata name="com.atlassw.tools.eclipse.checkstyle.comment" value="Disable method name checks"/>
160  </module>
161  <module name="SuppressionCommentFilter">
162    <property name="offCommentFormat" value="CheckStyle: stop parameter assignment check"/>
163    <property name="onCommentFormat" value="CheckStyle: resume parameter assignment check"/>
164    <property name="checkFormat" value="ParameterAssignment"/>
165    <property name="checkC" value="false"/>
166    <metadata name="com.atlassw.tools.eclipse.checkstyle.comment" value="Disable Parameter Assignment"/>
167  </module>
168  <module name="SuppressionCommentFilter">
169    <property name="offCommentFormat" value="Checkstyle: stop final variable check"/>
170    <property name="onCommentFormat" value="Checkstyle: resume final variable check"/>
171    <property name="checkFormat" value="FinalLocalVariable"/>
172    <metadata name="com.atlassw.tools.eclipse.checkstyle.comment" value="Disable final variable checks"/>
173  </module>
174  <module name="SuppressionCommentFilter">
175    <property name="offCommentFormat" value="Checkstyle: stop"/>
176    <property name="onCommentFormat" value="Checkstyle: resume"/>
177    <metadata name="com.atlassw.tools.eclipse.checkstyle.comment" value="Disable all checks"/>
178  </module>
179  <module name="SuppressionCommentFilter">
180    <property name="offCommentFormat" value="CheckStyle: stop inner assignment check"/>
181    <property name="onCommentFormat" value="CheckStyle: resume inner assignment check"/>
182    <property name="checkFormat" value="InnerAssignment"/>
183    <metadata name="com.atlassw.tools.eclipse.checkstyle.comment" value="Disable inner assignment checks"/>
184  </module>
185  <module name="SuppressionCommentFilter">
186    <property name="offCommentFormat" value="Checkstyle: stop field name check"/>
187    <property name="onCommentFormat" value="Checkstyle: resume field name check"/>
188    <property name="checkFormat" value="MemberName"/>
189    <property name="checkC" value="false"/>
190    <metadata name="com.atlassw.tools.eclipse.checkstyle.comment" value="Disable field name checks"/>
191  </module>
192  <module name="RegexpMultiline">
193    <metadata name="net.sf.eclipsecs.core.comment" value="illegal Windows line ending"/>
194    <property name="format" value="\r\n"/>
195    <property name="message" value="illegal Windows line ending"/>
196  </module>
197  <module name="SuppressionCommentFilter">
198    <property name="offCommentFormat" value="CheckStyle: stop header check"/>
199    <property name="onCommentFormat" value="CheckStyle: resume header check"/>
200    <property name="checkFormat" value=".*Header"/>
201    <metadata name="com.atlassw.tools.eclipse.checkstyle.comment" value="Disable header checks"/>
202  </module>
203  <module name="SuppressionCommentFilter">
204    <property name="offCommentFormat" value="CheckStyle: stop line length check"/>
205    <property name="onCommentFormat" value="CheckStyle: resume line length check"/>
206    <property name="checkFormat" value="LineLength"/>
207  </module>
208  <module name="SuppressionCommentFilter">
209    <property name="offCommentFormat" value="CheckStyle: start generated"/>
210    <property name="onCommentFormat" value="CheckStyle: stop generated"/>
211    <property name="checkFormat" value=".*Name|.*LineLength|.*Header"/>
212  </module>
213</module>
214