Skip to content
This repository was archived by the owner on Jan 18, 2024. It is now read-only.

Commit 11b118d

Browse files
Create checkstyle.xml
1 parent be4e3d1 commit 11b118d

File tree

1 file changed

+295
-0
lines changed

1 file changed

+295
-0
lines changed

checkstyle.xml

Lines changed: 295 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,295 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<!DOCTYPE module PUBLIC "-//Checkstyle//DTD Checkstyle Configuration 1.3//EN" "https://checkstyle.org/dtds/configuration_1_3.dtd">
3+
4+
<module name="Checker">
5+
<property name="severity" value="warning"/>
6+
<property name="fileExtensions" value="java, properties"/>
7+
<module name="TreeWalker">
8+
<module name="JavadocMethod">
9+
<metadata name="net.sf.eclipsecs.core.lastEnabledSeverity" value="inherit"/>
10+
</module>
11+
<module name="JavadocType">
12+
<property name="severity" value="ignore"/>
13+
<property name="scope" value="protected"/>
14+
<metadata name="net.sf.eclipsecs.core.lastEnabledSeverity" value="inherit"/>
15+
</module>
16+
<module name="JavadocVariable">
17+
<property name="severity" value="ignore"/>
18+
<metadata name="net.sf.eclipsecs.core.lastEnabledSeverity" value="inherit"/>
19+
</module>
20+
<module name="JavadocStyle">
21+
<property name="severity" value="ignore"/>
22+
<metadata name="net.sf.eclipsecs.core.lastEnabledSeverity" value="inherit"/>
23+
</module>
24+
<module name="ConstantName">
25+
<property name="id" value="ConstantName"/>
26+
<property name="format" value="^[A-Z_][A-Z0-9]*(_[A-Z0-9]*)*$"/>
27+
</module>
28+
<module name="LocalFinalVariableName">
29+
<property name="id" value="LocalFinalVariableName"/>
30+
<property name="format" value="^[a-z_][a-zA-Z0-9_]*$"/>
31+
</module>
32+
<module name="LocalVariableName">
33+
<property name="id" value="LocalVariableName"/>
34+
<property name="format" value="^[a-z_][a-zA-Z0-9_]*$"/>
35+
</module>
36+
<module name="MemberName">
37+
<property name="id" value="MemberName"/>
38+
<property name="format" value="^[a-z_][a-zA-Z0-9_]*$"/>
39+
</module>
40+
<module name="MethodName">
41+
<property name="id" value="MethodName"/>
42+
<property name="format" value="^[a-zA-Z_][a-zA-Z0-9_]*$"/>
43+
<message key="name.invalidPattern" value="'{0}'' does not match the pattern ''{1}''."/>
44+
</module>
45+
<module name="PackageName">
46+
<property name="id" value="PackageName"/>
47+
</module>
48+
<module name="ParameterName">
49+
<property name="id" value="ParameterName"/>
50+
<property name="format" value="^[a-z_][a-zA-Z0-9_]*$"/>
51+
</module>
52+
<module name="StaticVariableName">
53+
<property name="id" value="StaticVariableName"/>
54+
<property name="format" value="^[a-z_][a-zA-Z0-9_]*$"/>
55+
</module>
56+
<module name="TypeName">
57+
<property name="id" value="TypeName"/>
58+
<property name="format" value="^[A-Z_][a-zA-Z0-9_]*$"/>
59+
</module>
60+
<module name="AvoidStarImport">
61+
<property name="id" value="AvoidStarImport"/>
62+
</module>
63+
<module name="IllegalImport">
64+
<property name="id" value="IllegalImport"/>
65+
</module>
66+
<module name="RedundantImport">
67+
<property name="id" value="RedundantImport"/>
68+
</module>
69+
<module name="UnusedImports">
70+
<property name="id" value="UnusedImports"/>
71+
<message key="import.unused" value="Unsed import - {0}."/>
72+
</module>
73+
<module name="MethodLength">
74+
<property name="severity" value="ignore"/>
75+
<property name="id" value="MethodLength"/>
76+
<metadata name="net.sf.eclipsecs.core.lastEnabledSeverity" value="inherit"/>
77+
</module>
78+
<module name="MethodParamPad">
79+
<property name="severity" value="ignore"/>
80+
<property name="id" value="MethodParamPad"/>
81+
<property name="tokens" value="LITERAL_NEW"/>
82+
<metadata name="net.sf.eclipsecs.core.lastEnabledSeverity" value="inherit"/>
83+
</module>
84+
<module name="NoWhitespaceAfter">
85+
<property name="severity" value="warning"/>
86+
<property name="id" value="NoWhitespaceAfter"/>
87+
<property name="tokens" value="BNOT,DEC,DOT,INC,LNOT,UNARY_MINUS,UNARY_PLUS,TYPECAST"/>
88+
</module>
89+
<module name="NoWhitespaceBefore">
90+
<property name="id" value="NoWhitespaceBefore"/>
91+
<property name="tokens" value="POST_DEC,POST_INC"/>
92+
</module>
93+
<module name="OperatorWrap">
94+
<property name="id" value="OperatorWrap"/>
95+
</module>
96+
<module name="ParenPad">
97+
<property name="id" value="ParenPad"/>
98+
<property name="tokens" value="ANNOTATION,ANNOTATION_FIELD_DEF,CTOR_DEF,ENUM_CONSTANT_DEF,LITERAL_CATCH,LITERAL_DO,LITERAL_FOR,LITERAL_IF,LITERAL_SWITCH,LITERAL_SYNCHRONIZED,LITERAL_WHILE,METHOD_DEF,RESOURCE_SPECIFICATION,SUPER_CTOR_CALL,QUESTION"/>
99+
</module>
100+
<module name="TypecastParenPad">
101+
<property name="id" value="TypecastParenPad"/>
102+
</module>
103+
<module name="WhitespaceAfter">
104+
<property name="id" value="WhitespaceAfter"/>
105+
<property name="tokens" value="SEMI"/>
106+
</module>
107+
<module name="WhitespaceAround">
108+
<property name="id" value="WhitespaceAround"/>
109+
<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,LCURLY,LE,LOR,LT,MINUS,MINUS_ASSIGN,MOD,MOD_ASSIGN,NOT_EQUAL,PLUS,PLUS_ASSIGN,QUESTION,RCURLY,SL,SLIST,SL_ASSIGN,SR,SR_ASSIGN,STAR,STAR_ASSIGN,TYPE_EXTENSION_AND"/>
110+
</module>
111+
<module name="ModifierOrder">
112+
<property name="id" value="ModifierOrder"/>
113+
</module>
114+
<module name="EmptyBlock">
115+
<property name="id" value="EmptyBlock"/>
116+
</module>
117+
<module name="LeftCurly">
118+
<property name="id" value="LeftCurly"/>
119+
<property name="option" value="nl"/>
120+
</module>
121+
<module name="NeedBraces">
122+
<property name="id" value="NeedBraces"/>
123+
</module>
124+
<module name="RightCurly">
125+
<property name="id" value="RightCurly"/>
126+
<property name="option" value="alone"/>
127+
<property name="tokens" value="LITERAL_TRY,LITERAL_CATCH,LITERAL_FINALLY,LITERAL_IF,LITERAL_ELSE,CLASS_DEF,METHOD_DEF,CTOR_DEF,LITERAL_FOR,LITERAL_WHILE,LITERAL_DO,STATIC_INIT,INSTANCE_INIT"/>
128+
<message key="line.same" value="''{0}'' in column {1} should be on the same line as the next part of a multi-block-statement (one, that consists of mulitipe blocks: if/else-if/else or try/catch/finally)"/>
129+
</module>
130+
<module name="EmptyStatement">
131+
<property name="id" value="EmptyStatement"/>
132+
</module>
133+
<module name="EqualsHashCode">
134+
<property name="id" value="EqualsHashCode"/>
135+
</module>
136+
<module name="MagicNumber">
137+
<property name="id" value="MagicNumber"/>
138+
</module>
139+
<module name="MissingSwitchDefault">
140+
<message key="missing.switch.default" value="MissingSwitchDefault: without &quot;default&quot; case."/>
141+
</module>
142+
<module name="SimplifyBooleanExpression">
143+
<property name="id" value="SimplifyBooleanExpression"/>
144+
</module>
145+
<module name="HideUtilityClassConstructor">
146+
<property name="id" value="HideUtilityClassConstructor"/>
147+
</module>
148+
<module name="InterfaceIsType">
149+
<property name="id" value="InterfaceIsType"/>
150+
</module>
151+
<module name="VisibilityModifier">
152+
<property name="severity" value="warning"/>
153+
<property name="id" value="VisibilityModifier"/>
154+
<property name="packageAllowed" value="true"/>
155+
<property name="protectedAllowed" value="true"/>
156+
</module>
157+
<module name="ArrayTypeStyle">
158+
<property name="id" value="ArrayTypeStyle"/>
159+
</module>
160+
<module name="FinalParameters">
161+
<property name="id" value="FinalParameters"/>
162+
</module>
163+
<module name="TodoComment">
164+
<property name="severity" value="ignore"/>
165+
<message key="todo.match" value="TodoComment: Comment does not match to-do-Format ''{0}''."/>
166+
<metadata name="net.sf.eclipsecs.core.lastEnabledSeverity" value="inherit"/>
167+
</module>
168+
<module name="UpperEll">
169+
<property name="id" value="UpperEll"/>
170+
</module>
171+
<module name="RequireThis">
172+
<property name="severity" value="warning"/>
173+
<property name="id" value="RequireThis"/>
174+
</module>
175+
<module name="FinalClass">
176+
<property name="severity" value="warning"/>
177+
<property name="id" value="FinalClass"/>
178+
</module>
179+
<module name="GenericWhitespace">
180+
<property name="severity" value="ignore"/>
181+
<property name="id" value="GenericWhitespace"/>
182+
<metadata name="net.sf.eclipsecs.core.lastEnabledSeverity" value="warning"/>
183+
</module>
184+
<module name="EmptyCatchBlock">
185+
<property name="id" value="EmptyCatchBlock"/>
186+
</module>
187+
<module name="NonEmptyAtclauseDescription">
188+
<property name="severity" value="ignore"/>
189+
<metadata name="net.sf.eclipsecs.core.lastEnabledSeverity" value="inherit"/>
190+
</module>
191+
<module name="AbstractClassName">
192+
<property name="id" value="AbstractClassName"/>
193+
<property name="format" value="^Abstract.*$"/>
194+
</module>
195+
<module name="OuterTypeNumber">
196+
<property name="id" value="OuterTypeNumber"/>
197+
</module>
198+
<module name="DefaultComesLast">
199+
<property name="id" value="DefaultComesLast"/>
200+
</module>
201+
<module name="ExplicitInitialization">
202+
<property name="severity" value="ignore"/>
203+
<property name="id" value="ExplicitInitialization"/>
204+
<metadata name="net.sf.eclipsecs.core.lastEnabledSeverity" value="inherit"/>
205+
</module>
206+
<module name="NoClone">
207+
<property name="id" value="NoClone"/>
208+
</module>
209+
<module name="NoFinalizer">
210+
<property name="id" value="NoFinalizer"/>
211+
</module>
212+
<module name="StringLiteralEquality">
213+
<property name="id" value="StringLiteralEquality"/>
214+
</module>
215+
<module name="OneStatementPerLine">
216+
<property name="id" value="OneStatementPerLine"/>
217+
</module>
218+
<module name="EmptyForInitializerPad">
219+
<property name="id" value="EmptyForInitializerPad"/>
220+
</module>
221+
<module name="EmptyForIteratorPad">
222+
<property name="id" value="EmptyForIteratorPad"/>
223+
</module>
224+
<module name="OneTopLevelClass">
225+
<property name="id" value="OneTopLevelClass"/>
226+
</module>
227+
<module name="WhitespaceAfter">
228+
<property name="severity" value="ignore"/>
229+
<property name="tokens" value="SEMI,TYPECAST,LITERAL_IF,LITERAL_ELSE,LITERAL_WHILE,LITERAL_DO,LITERAL_FOR,DO_WHILE"/>
230+
<metadata name="net.sf.eclipsecs.core.lastEnabledSeverity" value="inherit"/>
231+
</module>
232+
<module name="WhitespaceAfter">
233+
<property name="severity" value="ignore"/>
234+
<property name="tokens" value="SEMI,TYPECAST,LITERAL_IF,LITERAL_ELSE,LITERAL_WHILE,LITERAL_DO,LITERAL_FOR,DO_WHILE"/>
235+
<metadata name="net.sf.eclipsecs.core.lastEnabledSeverity" value="inherit"/>
236+
</module>
237+
<module name="IllegalType">
238+
<!-- java.util.Optional should not be used for parameters. See https://rules.sonarsource.com/java/RSPEC-3553 -->
239+
<property name="tokens" value="PARAMETER_DEF"/>
240+
<property name="illegalClassNames" value="java.util.Optional"/>
241+
<metadata name="net.sf.eclipsecs.core.lastEnabledSeverity" value="inherit"/>
242+
</module>
243+
</module>
244+
<module name="BeforeExecutionExclusionFileFilter">
245+
<property name="fileNamePattern" value="package\-info\.java$"/>
246+
</module>
247+
<module name="JavadocPackage">
248+
<property name="severity" value="ignore"/>
249+
<metadata name="net.sf.eclipsecs.core.lastEnabledSeverity" value="inherit"/>
250+
</module>
251+
<module name="LineLength">
252+
<property name="severity" value="ignore"/>
253+
<property name="id" value="LineLength"/>
254+
<property name="max" value="120"/>
255+
<metadata name="net.sf.eclipsecs.core.lastEnabledSeverity" value="inherit"/>
256+
</module>
257+
<module name="NewlineAtEndOfFile">
258+
<property name="id" value="NewlineAtEndOfFile"/>
259+
</module>
260+
<module name="Translation">
261+
<property name="id" value="Translation"/>
262+
<message key="general.exception" value="general exception"/>
263+
<message key="general.fileNotFound" value="file not found"/>
264+
</module>
265+
<module name="FileLength">
266+
<property name="severity" value="ignore"/>
267+
<property name="id" value="FileLength"/>
268+
<metadata name="net.sf.eclipsecs.core.lastEnabledSeverity" value="inherit"/>
269+
</module>
270+
<module name="RegexpSingleline">
271+
<metadata name="net.sf.eclipsecs.core.comment" value="Inlined Tabs"/>
272+
<property name="severity" value="ignore"/>
273+
<property name="format" value="^(/*)\t*?[^\n\t/]+?\t"/>
274+
<property name="message" value="Inlined Tab"/>
275+
<property name="fileExtensions" value="java"/>
276+
<metadata name="net.sf.eclipsecs.core.lastEnabledSeverity" value="inherit"/>
277+
</module>
278+
<module name="RegexpSingleline">
279+
<metadata name="net.sf.eclipsecs.core.comment" value="CheckStyle Off Grund"/>
280+
<property name="format" value="CHECKSTYLE\.OFF\: *([\w\|]+)\s*$"/>
281+
<property name="message" value="Missing reason for checkstyle supression"/>
282+
<property name="fileExtensions" value="java"/>
283+
</module>
284+
<module name="RegexpSingleline">
285+
<metadata name="net.sf.eclipsecs.core.comment" value="CheckStyle All Off Grund"/>
286+
<property name="format" value="CHECKSTYLE\:OFF\s*$"/>
287+
<property name="message" value="Missing reason for checkstyle supression"/>
288+
<property name="fileExtensions" value="java"/>
289+
</module>
290+
<module name="SuppressWithPlainTextCommentFilter">
291+
<property name="offCommentFormat" value="CHECKSTYLE\:OFF\:(\w+)"/>
292+
<property name="onCommentFormat" value="CHECKSTYLE\:ON\:(\w+)"/>
293+
<property name="checkFormat" value="$1"/>
294+
</module>
295+
</module>

0 commit comments

Comments
 (0)