Skip to main content
aboutsummaryrefslogtreecommitdiffstats
blob: b7cd9351cdd34755eafd484697670f04f8d9222e (plain) (blame)
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
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!--
Copyright (c) 2012 Mia-Software

All rights reserved. This program and the accompanying materials
are made available under the terms of the Eclipse Public License v1.0
which accompanies this distribution, and is available at
http://www.eclipse.org/legal/epl-v10.html

Contributors:
	Grégoire Dupé (Mia-Software) - Bug 369196 - [Dev] We need an EMF Facet dedicated PMD rule set 
 -->
<ruleset xmlns="http://pmd.sf.net/ruleset/1.0.0" name="pmd"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xsi:noNamespaceSchemaLocation="http://pmd.sf.net/ruleset_xml_schema.xsd"
	xsi:schemaLocation="http://pmd.sf.net/ruleset/1.0.0 http://pmd.sf.net/ruleset_xml_schema.xsd">
	<description>PMD Plug-in preferences rule set dedicated to the project 'EMF Facet'.</description>
	<exclude-pattern>.*/internal/Messages.java</exclude-pattern>
	<exclude-pattern>.*/generated/.*\.java</exclude-pattern>
	<exclude-pattern>.*/src-.*/.*</exclude-pattern>
	<exclude-pattern>.*/.*-gen/.*</exclude-pattern>
	<rule ref="rulesets/typeresolution.xml/LooseCoupling" />
	<rule ref="rulesets/typeresolution.xml/CloneMethodMustImplementCloneable" />
	<rule ref="rulesets/typeresolution.xml/UnusedImports" />
	<rule ref="rulesets/typeresolution.xml/SignatureDeclareThrowsException" />
	<rule ref="rulesets/braces.xml/IfStmtsMustUseBraces" />
	<rule ref="rulesets/braces.xml/WhileLoopsMustUseBraces" />
	<rule ref="rulesets/braces.xml/IfElseStmtsMustUseBraces" />
	<rule ref="rulesets/braces.xml/ForLoopsMustUseBraces" />
	<rule ref="rulesets/design.xml/UseSingleton" />
	<rule ref="rulesets/design.xml/SimplifyBooleanReturns" />
	<rule ref="rulesets/design.xml/SimplifyBooleanExpressions" />
	<rule ref="rulesets/design.xml/SwitchStmtsShouldHaveDefault" />
	<rule ref="rulesets/design.xml/AvoidDeeplyNestedIfStmts" />
	<rule ref="rulesets/design.xml/AvoidReassigningParameters" />
	<rule ref="rulesets/design.xml/SwitchDensity" />
	<rule ref="rulesets/design.xml/ConstructorCallsOverridableMethod">
		<priority>3</priority>
	</rule>
	<rule ref="rulesets/design.xml/AccessorClassGeneration" />
	<rule ref="rulesets/design.xml/FinalFieldCouldBeStatic" />
	<rule ref="rulesets/design.xml/CloseResource" />
	<rule ref="rulesets/design.xml/NonStaticInitializer" />
	<rule ref="rulesets/design.xml/DefaultLabelNotLastInSwitchStmt" />
	<rule ref="rulesets/design.xml/NonCaseLabelInSwitchStatement" />
	<rule ref="rulesets/design.xml/OptimizableToArrayCall" />
	<rule ref="rulesets/design.xml/BadComparison" />
	<rule ref="rulesets/design.xml/EqualsNull" />
	<rule ref="rulesets/design.xml/ConfusingTernary" />
	<rule ref="rulesets/design.xml/InstantiationToGetClass" />
	<rule ref="rulesets/design.xml/IdempotentOperations" />
	<rule ref="rulesets/design.xml/SimpleDateFormatNeedsLocale" />
	<rule ref="rulesets/design.xml/ImmutableField" />
	<rule ref="rulesets/design.xml/UseLocaleWithCaseConversions" />
	<rule ref="rulesets/design.xml/AvoidProtectedFieldInFinalClass" />
	<rule ref="rulesets/design.xml/AssignmentToNonFinalStatic" />
	<rule ref="rulesets/design.xml/MissingStaticMethodInNonInstantiatableClass" />
	<rule ref="rulesets/design.xml/AvoidSynchronizedAtMethodLevel" />
	<rule ref="rulesets/design.xml/MissingBreakInSwitch" />
	<rule ref="rulesets/design.xml/UseNotifyAllInsteadOfNotify" />
	<rule ref="rulesets/design.xml/AvoidInstanceofChecksInCatchClause" />
	<rule ref="rulesets/design.xml/AbstractClassWithoutAbstractMethod" />
	<rule ref="rulesets/design.xml/SimplifyConditional" />
	<rule ref="rulesets/design.xml/CompareObjectsWithEquals" />
	<rule ref="rulesets/design.xml/PositionLiteralsFirstInComparisons" />
	<rule ref="rulesets/design.xml/UnnecessaryLocalBeforeReturn" />
	<rule ref="rulesets/design.xml/NonThreadSafeSingleton" />
	<rule ref="rulesets/design.xml/UncommentedEmptyMethod" />
	<rule ref="rulesets/design.xml/UncommentedEmptyConstructor" />
	<rule ref="rulesets/design.xml/AvoidConstantsInterface" />
	<rule ref="rulesets/design.xml/UnsynchronizedStaticDateFormatter" />
	<rule ref="rulesets/design.xml/PreserveStackTrace" />
	<rule ref="rulesets/design.xml/UseCollectionIsEmpty" />
	<rule
		ref="rulesets/design.xml/ClassWithOnlyPrivateConstructorsShouldBeFinal" />
	<rule ref="rulesets/design.xml/EmptyMethodInAbstractClassShouldBeAbstract">
		<priority>3</priority>
	</rule>
	<rule ref="rulesets/design.xml/SingularField" />
	<rule ref="rulesets/design.xml/ReturnEmptyArrayRatherThanNull" >
		<priority>3</priority>
	</rule>
	<rule ref="rulesets/design.xml/AbstractClassWithoutAnyMethod" />
	<rule ref="rulesets/design.xml/TooFewBranchesForASwitchStatement" />
	<rule ref="rulesets/strictexception.xml/AvoidCatchingThrowable" />
	<rule ref="rulesets/strictexception.xml/SignatureDeclareThrowsException" />
	<rule ref="rulesets/strictexception.xml/ExceptionAsFlowControl" />
	<rule ref="rulesets/strictexception.xml/AvoidCatchingNPE" />
	<rule ref="rulesets/strictexception.xml/AvoidThrowingRawExceptionTypes">
		<priority>3</priority>
	</rule>
	<rule ref="rulesets/strictexception.xml/AvoidThrowingNullPointerException" />
	<rule ref="rulesets/strictexception.xml/AvoidRethrowingException" />
	<rule ref="rulesets/strictexception.xml/DoNotExtendJavaLangError" />
	<rule ref="rulesets/strictexception.xml/DoNotThrowExceptionInFinally" />
	<rule
		ref="rulesets/strictexception.xml/AvoidThrowingNewInstanceOfSameException" />
	<rule ref="rulesets/unusedcode.xml/UnusedPrivateField" />
	<rule ref="rulesets/unusedcode.xml/UnusedLocalVariable" />
	<rule ref="rulesets/unusedcode.xml/UnusedPrivateMethod" />
	<rule ref="rulesets/unusedcode.xml/UnusedFormalParameter" />
	<rule ref="rulesets/logging-java.xml/MoreThanOneLogger" />
	<rule ref="rulesets/logging-java.xml/LoggerIsNotStaticFinal" />
	<rule ref="rulesets/logging-java.xml/SystemPrintln">
		<priority>3</priority>
	</rule>
	<rule ref="rulesets/logging-java.xml/AvoidPrintStackTrace" />
	<rule ref="rulesets/strings.xml/AvoidDuplicateLiterals" />
	<rule ref="rulesets/strings.xml/StringInstantiation">
		<priority>3</priority>
	</rule>
	<rule ref="rulesets/strings.xml/StringToString" />
	<rule ref="rulesets/strings.xml/InefficientStringBuffering" />
	<rule ref="rulesets/strings.xml/UnnecessaryCaseChange" />
	<rule ref="rulesets/strings.xml/UseStringBufferLength" />
	<rule ref="rulesets/strings.xml/AppendCharacterWithChar" />
	<rule ref="rulesets/strings.xml/ConsecutiveLiteralAppends" />
	<rule ref="rulesets/strings.xml/UseIndexOfChar" />
	<rule ref="rulesets/strings.xml/InefficientEmptyStringCheck" />
	<rule ref="rulesets/strings.xml/InsufficientStringBufferDeclaration" />
	<rule ref="rulesets/strings.xml/UselessStringValueOf" />
	<rule ref="rulesets/strings.xml/StringBufferInstantiationWithChar" />
	<rule ref="rulesets/strings.xml/UseEqualsToCompareStrings" />
	<rule ref="rulesets/strings.xml/AvoidStringBufferField" />
	<rule ref="rulesets/migrating.xml/ReplaceVectorWithList" />
	<rule ref="rulesets/migrating.xml/ReplaceHashtableWithMap" />
	<rule ref="rulesets/migrating.xml/ReplaceEnumerationWithIterator" />
	<rule ref="rulesets/migrating.xml/AvoidEnumAsIdentifier" />
	<rule ref="rulesets/migrating.xml/AvoidAssertAsIdentifier" />
	<rule ref="rulesets/migrating.xml/IntegerInstantiation" />
	<rule ref="rulesets/migrating.xml/ByteInstantiation" />
	<rule ref="rulesets/migrating.xml/ShortInstantiation" />
	<rule ref="rulesets/migrating.xml/LongInstantiation" />
	<rule ref="rulesets/migrating.xml/JUnit4TestShouldUseBeforeAnnotation" />
	<rule ref="rulesets/migrating.xml/JUnit4TestShouldUseAfterAnnotation" />
	<rule ref="rulesets/migrating.xml/JUnit4TestShouldUseTestAnnotation" />
	<rule ref="rulesets/migrating.xml/JUnit4SuitesShouldUseSuiteAnnotation" />
	<rule ref="rulesets/migrating.xml/JUnitUseExpected" />
	<rule ref="rulesets/j2ee.xml">
	<!-- Thes rule 'DoNotUseThreads' cause false positves in the EMF Facet beacause EMF Facet 
		is not a J2EE aplication and then can use threads -->
		<exclude name="DoNotUseThreads" />
	</rule>
	<rule ref="rulesets/optimizations.xml/LocalVariableCouldBeFinal" />
	<rule ref="rulesets/optimizations.xml/MethodArgumentCouldBeFinal" />
	<rule ref="rulesets/optimizations.xml/AvoidInstantiatingObjectsInLoops" />
	<rule ref="rulesets/optimizations.xml/UseArrayListInsteadOfVector" />
	<rule ref="rulesets/optimizations.xml/SimplifyStartsWith" />
	<rule ref="rulesets/optimizations.xml/UseStringBufferForStringAppends" />
	<rule ref="rulesets/optimizations.xml/UseArraysAsList" />
	<rule ref="rulesets/optimizations.xml/AvoidArrayLoops" />
	<rule ref="rulesets/optimizations.xml/UnnecessaryWrapperObjectCreation" />
	<rule ref="rulesets/optimizations.xml/AddEmptyString" />
	<rule ref="rulesets/basic.xml/EmptyCatchBlock" />
	<rule ref="rulesets/basic.xml/EmptyIfStmt" />
	<rule ref="rulesets/basic.xml/EmptyWhileStmt" />
	<rule ref="rulesets/basic.xml/EmptyTryBlock" />
	<rule ref="rulesets/basic.xml/EmptyFinallyBlock" />
	<rule ref="rulesets/basic.xml/EmptySwitchStatements" />
	<rule ref="rulesets/basic.xml/JumbledIncrementer" />
	<rule ref="rulesets/basic.xml/ForLoopShouldBeWhileLoop" />
	<rule ref="rulesets/basic.xml/UnnecessaryConversionTemporary" />
	<rule ref="rulesets/basic.xml/OverrideBothEqualsAndHashcode" />
	<rule ref="rulesets/basic.xml/DoubleCheckedLocking" />
	<rule ref="rulesets/basic.xml/ReturnFromFinallyBlock" />
	<rule ref="rulesets/basic.xml/EmptySynchronizedBlock" />
	<rule ref="rulesets/basic.xml/UnnecessaryReturn" />
	<rule ref="rulesets/basic.xml/EmptyStaticInitializer" />
	<rule ref="rulesets/basic.xml/UnconditionalIfStatement" />
	<rule ref="rulesets/basic.xml/EmptyStatementNotInLoop" />
	<rule ref="rulesets/basic.xml/BooleanInstantiation">
		<priority>3</priority>
	</rule>
	<rule ref="rulesets/basic.xml/UnnecessaryFinalModifier" />
	<rule ref="rulesets/basic.xml/CollapsibleIfStatements" />
	<rule ref="rulesets/basic.xml/UselessOverridingMethod" />
	<rule ref="rulesets/basic.xml/ClassCastExceptionWithToArray" />
	<rule ref="rulesets/basic.xml/AvoidDecimalLiteralsInBigDecimalConstructor" />
	<rule ref="rulesets/basic.xml/UselessOperationOnImmutable" />
	<rule ref="rulesets/basic.xml/MisplacedNullCheck" />
	<rule ref="rulesets/basic.xml/UnusedNullCheckInEquals" />
	<rule ref="rulesets/basic.xml/AvoidThreadGroup" />
	<rule ref="rulesets/basic.xml/BrokenNullCheck" />
	<rule ref="rulesets/basic.xml/BigIntegerInstantiation" />
	<rule ref="rulesets/basic.xml/AvoidUsingOctalValues" />
	<rule ref="rulesets/basic.xml/AvoidUsingHardCodedIP" />
	<rule ref="rulesets/basic.xml/CheckResultSet" />
	<rule ref="rulesets/basic.xml/AvoidMultipleUnaryOperators" />
	<rule ref="rulesets/basic.xml/EmptyInitializer" />
	<rule ref="rulesets/sunsecure.xml/MethodReturnsInternalArray" />
	<rule ref="rulesets/sunsecure.xml/ArrayIsStoredDirectly" />
	<rule ref="rulesets/coupling.xml/CouplingBetweenObjects" />
	<rule ref="rulesets/coupling.xml/ExcessiveImports" />
	<rule ref="rulesets/coupling.xml/LooseCoupling" />
	<rule ref="rulesets/imports.xml/DuplicateImports" />
	<rule ref="rulesets/imports.xml/DontImportJavaLang" />
	<rule ref="rulesets/imports.xml/UnusedImports" />
	<rule ref="rulesets/imports.xml/ImportFromSamePackage" />
	<rule ref="rulesets/imports.xml/TooManyStaticImports" />
	<rule ref="rulesets/junit.xml/JUnitStaticSuite" />
	<rule ref="rulesets/junit.xml/JUnitSpelling" />
	<rule ref="rulesets/junit.xml/JUnitAssertionsShouldIncludeMessage" />
	<rule ref="rulesets/junit.xml/JUnitTestsShouldIncludeAssert" />
	<rule ref="rulesets/junit.xml/TestClassWithoutTestCases" />
	<rule ref="rulesets/junit.xml/UnnecessaryBooleanAssertion" />
	<rule ref="rulesets/junit.xml/UseAssertEqualsInsteadOfAssertTrue" />
	<rule ref="rulesets/junit.xml/UseAssertSameInsteadOfAssertTrue" />
	<rule ref="rulesets/junit.xml/UseAssertNullInsteadOfAssertTrue" />
	<rule ref="rulesets/junit.xml/SimplifyBooleanAssertion" />
	<rule ref="rulesets/controversial.xml" >
		<!-- The rule 'DataflowAnomalyAnalysis' generates to many false positive. -->
		<exclude name="DataflowAnomalyAnalysis" />
		<exclude name="BooleanInversion" />
	</rule>
	<rule ref="rulesets/naming.xml/ShortVariable" />
	<rule ref="rulesets/naming.xml/LongVariable" />
	<rule ref="rulesets/naming.xml/ShortMethodName" />
	<rule ref="rulesets/naming.xml/VariableNamingConventions">
		<priority>3</priority>
	</rule>
	<rule ref="rulesets/naming.xml/MethodNamingConventions" />
	<rule ref="rulesets/naming.xml/ClassNamingConventions" />
	<rule ref="rulesets/naming.xml/AbstractNaming" />
	<rule ref="rulesets/naming.xml/AvoidDollarSigns" />
	<rule ref="rulesets/naming.xml/MethodWithSameNameAsEnclosingClass" />
	<rule ref="rulesets/naming.xml/SuspiciousHashcodeMethodName" />
	<rule ref="rulesets/naming.xml/SuspiciousConstantFieldName" />
	<rule ref="rulesets/naming.xml/SuspiciousEqualsMethodName" />
	<rule ref="rulesets/naming.xml/AvoidFieldNameMatchingTypeName" />
	<rule ref="rulesets/naming.xml/AvoidFieldNameMatchingMethodName" />
	<rule ref="rulesets/naming.xml/NoPackage" />
	<rule ref="rulesets/naming.xml/PackageCase" />
	<rule ref="rulesets/naming.xml/MisleadingVariableName" />
	<rule ref="rulesets/naming.xml/BooleanGetMethodName" />
	<rule ref="rulesets/codesize.xml/NPathComplexity" />
	<rule ref="rulesets/codesize.xml/ExcessiveMethodLength" />
	<rule ref="rulesets/codesize.xml/ExcessiveParameterList" />
	<rule ref="rulesets/codesize.xml/ExcessiveClassLength" />
	<rule ref="rulesets/codesize.xml/CyclomaticComplexity" />
	<rule ref="rulesets/codesize.xml/ExcessivePublicCount" />
	<rule ref="rulesets/codesize.xml/TooManyFields" />
	<rule ref="rulesets/codesize.xml/NcssMethodCount" />
	<rule ref="rulesets/codesize.xml/NcssTypeCount" />
	<rule ref="rulesets/codesize.xml/NcssConstructorCount" />
	<!-- This maximum number of methods is set to 10 by default. I assume that 
		10 is tolerant approximation of 7 (+/- 2) which is number of item that a 
		humane brain can managed in one time. If we apply this rule to UI or a functional 
		component, we will get at least 7 “functional” methods on a UI class and 
		we will have to add all the technical methods (about twice). So the total 
		amount of methods will regularly be near 14. This is definitively over the 
		human brain capacity. Those considerations lead me to conclude that to increase 
		the number of methods limit is useless. That why, to my mind this rule will 
		not be applicable in the majority of cases. This rule must then be deprecated. -->
	<!--  <rule ref="rulesets/codesize.xml/TooManyMethods" /> -->
	<rule ref="rulesets/finalizers.xml/EmptyFinalizer" />
	<rule ref="rulesets/finalizers.xml/FinalizeOnlyCallsSuperFinalize" />
	<rule ref="rulesets/finalizers.xml/FinalizeOverloaded" />
	<rule ref="rulesets/finalizers.xml/FinalizeDoesNotCallSuperFinalize" />
	<rule ref="rulesets/finalizers.xml/FinalizeShouldBeProtected" />
	<rule ref="rulesets/finalizers.xml/AvoidCallingFinalize" />
	<rule ref="rulesets/logging-jakarta-commons.xml/UseCorrectExceptionLogging" />
	<rule ref="rulesets/logging-jakarta-commons.xml/ProperLogger" />
	<rule ref="rulesets/javabeans.xml">
		<!-- The rule 'BeanMembersShouldSerialize' is useless in the EMF Facet context beacause each bean has 
			to be implemented using an ecore model. -->
		<exclude name="BeanMembersShouldSerialize" />
	</rule>
	<rule ref="rulesets/clone.xml/ProperCloneImplementation" >
		<priority>3</priority>
	</rule>
	<rule ref="rulesets/clone.xml/CloneThrowsCloneNotSupportedException" />
	<rule ref="rulesets/clone.xml/CloneMethodMustImplementCloneable" />
</ruleset>

Back to the top