summaryrefslogtreecommitdiffstats
path: root/.code_styling/APPC CheckStyle Preferences.xml
blob: df715240ede942b749b43f208f90d26225cf48c5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
<!--
============LICENSE_START==========================================
ONAP : APPC
===================================================================
Copyright (C) 2017-2018 AT&T Intellectual Property. All rights reserved.
===================================================================

Unless otherwise specified, all software contained herein is licensed
under the Apache License, Version 2.0 (the License);
you may not use this software except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

ECOMP is a trademark and service mark of AT&T Intellectual Property.
============LICENSE_END============================================
-->
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE module PUBLIC "-//Puppy Crawl//DTD Check Configuration 1.3//EN" "http://www.puppycrawl.com/dtds/configuration_1_3.dtd">

<!--
    This configuration file was written by the eclipse-cs plugin configuration editor
-->
<!--
    Checkstyle-Configuration: APPC Rules
    Description: none
-->
<module name="Checker">
  <property name="severity" value="warning"/>
  <property name="charset" value="UTF-8"/>
  <module name="TreeWalker">
    <module name="FileContentsHolder"/>
    <module name="OuterTypeFilename">
      <property name="severity" value="error"/>
    </module>
    <module name="IllegalTokenText">
      <property name="severity" value="warning"/>
      <property name="tokens" value="CHAR_LITERAL,STRING_LITERAL"/>
      <property name="format" value="\\u00(08|09|0(a|A)|0(c|C)|0(d|D)|22|27|5(C|c))|\\(0(10|11|12|14|15|42|47)|134)"/>
      <property name="message" value="Avoid using corresponding octal or Unicode escape."/>
      <message key="illegal.token.text" value="Token text matches the illegal pattern ''{0}''. Avoid using Octal or Unicode escape sequences.  They are confusing and often error prone."/>
    </module>
    <module name="AvoidEscapedUnicodeCharacters">
      <property name="severity" value="warning"/>
      <property name="allowEscapesForControlCharacters" value="true"/>
      <property name="allowByTailComment" value="true"/>
      <property name="allowNonPrintableEscapes" value="true"/>
    </module>
    <module name="LineLength">
      <property name="severity" value="info"/>
      <property name="ignorePattern" value="^package.*|^import.*|a href|href|http://|https://|ftp://"/>
      <property name="max" value="120"/>
    </module>
    <module name="AvoidStarImport">
      <property name="severity" value="error"/>
    </module>
    <module name="NoLineWrap"/>
    <module name="EmptyBlock">
      <property name="severity" value="error"/>
      <property name="option" value="text"/>
      <property name="tokens" value="LITERAL_TRY,LITERAL_CATCH,LITERAL_FINALLY,LITERAL_IF,LITERAL_ELSE,LITERAL_SWITCH"/>
    </module>
    <module name="NeedBraces">
      <property name="severity" value="warning"/>
    </module>
    <module name="OneStatementPerLine">
      <property name="severity" value="warning"/>
    </module>
    <module name="MultipleVariableDeclarations">
      <property name="severity" value="warning"/>
    </module>
    <module name="ArrayTypeStyle">
      <property name="severity" value="info"/>
    </module>
    <module name="UpperEll">
      <property name="severity" value="warning"/>
    </module>
    <module name="ModifierOrder">
      <property name="severity" value="warning"/>
    </module>
    <module name="EmptyLineSeparator">
      <property name="severity" value="info"/>
      <property name="allowNoEmptyLineBetweenFields" value="true"/>
    </module>
    <module name="PackageName">
      <property name="severity" value="warning"/>
      <property name="format" value="^[a-z]+(\.[a-z][a-z0-9]*)*$"/>
      <message key="name.invalidPattern" value="Package name ''{0}'' must match pattern ''{1}''."/>
    </module>
    <module name="TypeName">
      <property name="severity" value="warning"/>
      <message key="name.invalidPattern" value="Type name ''{0}'' must match pattern ''{1}''."/>
    </module>
    <module name="MemberName">
      <property name="severity" value="warning"/>
      <property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9]*$"/>
      <message key="name.invalidPattern" value="Member name ''{0}'' must match pattern ''{1}''."/>
    </module>
    <module name="ParameterName">
      <property name="severity" value="warning"/>
      <property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9]*$"/>
      <message key="name.invalidPattern" value="Parameter name ''{0}'' must match pattern ''{1}''."/>
    </module>
    <module name="LocalVariableName">
      <property name="severity" value="warning"/>
      <property name="format" value="^[a-z][a-zA-Z0-9_]*$"/>
      <property name="allowOneCharVarInForLoop" value="true"/>
      <message key="name.invalidPattern" value="Local variable name ''{0}'' must match pattern ''{1}''."/>
    </module>
    <module name="ClassTypeParameterName">
      <property name="severity" value="warning"/>
      <property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)"/>
      <message key="name.invalidPattern" value="Class type name ''{0}'' must match pattern ''{1}''."/>
    </module>
    <module name="MethodTypeParameterName">
      <property name="severity" value="warning"/>
      <property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)"/>
      <message key="name.invalidPattern" value="Method type name ''{0}'' must match pattern ''{1}''."/>
    </module>
    <module name="NoFinalizer">
      <property name="severity" value="error"/>
    </module>
    <module name="VariableDeclarationUsageDistance">
      <property name="severity" value="info"/>
      <property name="allowedDistance" value="5"/>
    </module>
    <module name="MethodParamPad">
      <property name="severity" value="info"/>
    </module>
    <module name="AnnotationLocation">
      <property name="severity" value="warning"/>
      <property name="allowSamelineMultipleAnnotations" value="true"/>
    </module>
    <module name="NonEmptyAtclauseDescription">
      <property name="severity" value="warning"/>
    </module>
    <module name="SummaryJavadocCheck">
      <property name="severity" value="ignore"/>
      <metadata name="net.sf.eclipsecs.core.lastEnabledSeverity" value="inherit"/>
    </module>
    <module name="JavadocMethod">
      <property name="severity" value="warning"/>
      <property name="minLineCount" value="2"/>
      <property name="allowedAnnotations" value="Override, Test"/>
      <property name="scope" value="protected"/>
      <property name="allowThrowsTagsForSubclasses" value="true"/>
      <property name="allowMissingThrowsTags" value="true"/>
      <property name="allowMissingReturnTag" value="true"/>
      <property name="suppressLoadErrors" value="true"/>
    </module>
    <module name="MethodName">
      <property name="severity" value="warning"/>
      <property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9_]*$"/>
      <message key="name.invalidPattern" value="Method name ''{0}'' must match pattern ''{1}''."/>
    </module>
    <module name="JavadocType">
      <property name="severity" value="warning"/>
      <property name="scope" value="protected"/>
    </module>
    <module name="JavadocStyle">
      <property name="severity" value="warning"/>
      <property name="scope" value="protected"/>
      <property name="checkFirstSentence" value="false"/>
    </module>
    <module name="JavadocVariable">
      <property name="severity" value="warning"/>
      <property name="excludeScope" value="private"/>
      <property name="scope" value="protected"/>
    </module>
    <module name="ConstantName">
      <property name="severity" value="warning"/>
    </module>
    <module name="InterfaceTypeParameterName">
      <property name="severity" value="warning"/>
    </module>
    <module name="IllegalImport">
      <property name="severity" value="error"/>
    </module>
    <module name="RedundantImport">
      <property name="severity" value="warning"/>
    </module>
    <module name="UnusedImports">
      <property name="severity" value="info"/>
    </module>
    <module name="AnonInnerLength">
      <property name="severity" value="info"/>
    </module>
    <module name="MethodLength">
      <property name="severity" value="info"/>
    </module>
    <module name="ParameterNumber">
      <property name="severity" value="info"/>
    </module>
    <module name="OuterTypeNumber">
      <property name="severity" value="error"/>
    </module>
    <module name="EmptyForInitializerPad">
      <property name="severity" value="info"/>
    </module>
    <module name="EmptyForIteratorPad">
      <property name="severity" value="info"/>
    </module>
    <module name="ParenPad">
      <property name="severity" value="info"/>
    </module>
    <module name="TypecastParenPad">
      <property name="severity" value="info"/>
      <property name="tokens" value="RPAREN,TYPECAST"/>
    </module>
    <module name="RedundantModifier">
      <property name="severity" value="warning"/>
    </module>
    <module name="AvoidNestedBlocks">
      <property name="severity" value="warning"/>
      <property name="allowInSwitchCase" value="true"/>
    </module>
    <module name="CovariantEquals">
      <property name="severity" value="warning"/>
    </module>
    <module name="DefaultComesLast">
      <property name="severity" value="info"/>
    </module>
    <module name="DeclarationOrder">
      <property name="severity" value="ignore"/>
      <metadata name="net.sf.eclipsecs.core.lastEnabledSeverity" value="info"/>
    </module>
    <module name="EmptyStatement">
      <property name="severity" value="error"/>
    </module>
    <module name="EqualsAvoidNull">
      <property name="severity" value="warning"/>
    </module>
    <module name="EqualsHashCode">
      <property name="severity" value="warning"/>
    </module>
    <module name="HiddenField">
      <property name="severity" value="warning"/>
      <property name="ignoreConstructorParameter" value="true"/>
      <property name="ignoreSetter" value="true"/>
    </module>
    <module name="IllegalInstantiation">
      <property name="severity" value="warning"/>
      <property name="classes" value="java.lang.Boolean"/>
    </module>
    <module name="IllegalCatch">
      <property name="severity" value="warning"/>
      <message key="illegal.catch" value="Catching java.lang.Exception or unchecked exceptions should not be done!"/>
    </module>
    <module name="IllegalThrows">
      <property name="severity" value="warning"/>
    </module>
    <module name="InnerAssignment">
      <property name="severity" value="warning"/>
    </module>
    <module name="MagicNumber">
      <property name="severity" value="warning"/>
    </module>
    <module name="MissingCtor">
      <property name="severity" value="info"/>
    </module>
    <module name="ModifiedControlVariable">
      <property name="severity" value="error"/>
    </module>
    <module name="MultipleStringLiterals">
      <property name="severity" value="info"/>
    </module>
    <module name="MultipleVariableDeclarations">
      <property name="severity" value="warning"/>
    </module>
    <module name="NestedForDepth">
      <property name="severity" value="warning"/>
      <property name="max" value="4"/>
    </module>
    <module name="NestedIfDepth">
      <property name="severity" value="warning"/>
      <property name="max" value="4"/>
    </module>
    <module name="NestedTryDepth">
      <property name="severity" value="warning"/>
      <property name="max" value="2"/>
    </module>
    <module name="PackageDeclaration">
      <property name="severity" value="error"/>
    </module>
    <module name="ParameterAssignment">
      <property name="severity" value="error"/>
      <message key="parameter.assignment" value="Assignment of parameter ''{0}'' should not be done.  The effect of doing this could cause side effects with the calling method(s)."/>
    </module>
    <module name="ReturnCount">
      <property name="severity" value="warning"/>
    </module>
    <module name="SimplifyBooleanExpression">
      <property name="severity" value="info"/>
    </module>
    <module name="SimplifyBooleanReturn">
      <property name="severity" value="info"/>
    </module>
    <module name="StringLiteralEquality">
      <property name="severity" value="warning"/>
    </module>
    <module name="SuperClone">
      <property name="severity" value="error"/>
    </module>
    <module name="UnnecessaryParentheses">
      <property name="severity" value="info"/>
    </module>
    <module name="OneStatementPerLine">
      <property name="severity" value="warning"/>
    </module>
    <module name="FinalClass">
      <property name="severity" value="warning"/>
    </module>
    <module name="InnerTypeLast">
      <property name="severity" value="warning"/>
    </module>
    <module name="HideUtilityClassConstructor">
      <property name="severity" value="error"/>
    </module>
    <module name="InterfaceIsType">
      <property name="severity" value="warning"/>
    </module>
    <module name="VisibilityModifier">
      <property name="severity" value="error"/>
      <property name="protectedAllowed" value="true"/>
    </module>
    <module name="ClassDataAbstractionCoupling">
      <property name="severity" value="info"/>
    </module>
    <module name="ClassFanOutComplexity">
      <property name="severity" value="info"/>
    </module>
    <module name="CyclomaticComplexity">
      <property name="severity" value="info"/>
    </module>
    <module name="NPathComplexity">
      <property name="severity" value="info"/>
    </module>
    <module name="TodoComment">
      <property name="severity" value="warning"/>
    </module>
    <module name="UncommentedMain">
      <property name="severity" value="warning"/>
    </module>
  </module>
  <module name="FileTabCharacter">
    <property name="severity" value="warning"/>
    <property name="eachLine" value="true"/>
  </module>
  <module name="UniqueProperties">
    <property name="severity" value="warning"/>
  </module>
  <module name="SuppressionFilter">
    <property name="file" value="${samedir}/Checkstyle_Suppression_Filter.xml"/>
  </module>
  <module name="SuppressionCommentFilter">
    <property name="offCommentFormat" value="@sonar:off"/>
    <property name="onCommentFormat" value="@sonar:on"/>
  </module>
</module>