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
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<!-- Generated by Apache Maven Doxia Site Renderer 1.4 at 18 Feb 2015 -->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<title>CodeNarc - CodeNarc - Naming Rules</title>
<style type="text/css" media="all">
@import url("./css/maven-base.css");
@import url("./css/maven-theme.css");
@import url("./css/site.css");
</style>
<link rel="stylesheet" href="./css/print.css" type="text/css" media="print" />
<meta name="Date-Revision-yyyymmdd" content="20150218" />
<meta http-equiv="Content-Language" content="en" />
</head>
<body class="composite">
<div id="banner">
<a href="./" id="bannerLeft">
<img src="images/codenarc-logo.png" alt="CodeNarc" />
</a>
<a href="http://github.com/CodeNarc" id="bannerRight">
<img src="images/forkme_right_red_aa0000.png" alt="Fork me on GitHub" />
</a>
<div class="clear">
<hr/>
</div>
</div>
<div id="breadcrumbs">
<div class="xleft">
<span id="publishDate">Last Published: 18 Feb 2015</span>
| <span id="projectVersion">Version: 0.23</span>
</div>
<div class="xright">
</div>
<div class="clear">
<hr/>
</div>
</div>
<div id="leftColumn">
<div id="navcolumn">
<h5>General</h5>
<ul>
<li class="none">
<a href="index.html" title="Home">Home</a>
</li>
<li class="none">
<a href="https://sourceforge.net/project/showfiles.php?group_id=250145" class="externalLink" title="Downloads">Downloads</a>
</li>
<li class="none">
<a href="apidocs/index.html" title="Javadocs">Javadocs</a>
</li>
<li class="none">
<a href="http://sourceforge.net/mail/?group_id=250145" class="externalLink" title="Mailing Lists">Mailing Lists</a>
</li>
<li class="none">
<a href="http://sourceforge.net/tracker/?group_id=250145" class="externalLink" title="Bug Tracker">Bug Tracker</a>
</li>
<li class="none">
<a href="http://sourceforge.net/projects/codenarc" class="externalLink" title="SourceForge Project">SourceForge Project</a>
</li>
<li class="none">
<a href="http://github.com/CodeNarc" class="externalLink" title="GitHub Project">GitHub Project</a>
</li>
</ul>
<h5>Running</h5>
<ul>
<li class="none">
<a href="codenarc-ant-task.html" title="Ant Task Usage">Ant Task Usage</a>
</li>
<li class="none">
<a href="codenarc-command-line.html" title="Command-Line">Command-Line</a>
</li>
<li class="none">
<a href="codenarc-run-as-a-test.html" title="Run as a Test">Run as a Test</a>
</li>
<li class="none">
<a href="codenarc-other-tools-frameworks.html" title="Other Tools/Frameworks">Other Tools/Frameworks</a>
</li>
</ul>
<h5>Using</h5>
<ul>
<li class="none">
<a href="codenarc-creating-ruleset.html" title="Creating a RuleSet">Creating a RuleSet</a>
</li>
<li class="none">
<a href="codenarc-creating-rule.html" title="Creating a Rule">Creating a Rule</a>
</li>
<li class="none">
<a href="codenarc-configuring-rules.html" title="Configuring Rules">Configuring Rules</a>
</li>
<li class="none">
<a href="StarterRuleSet-AllRulesByCategory.groovy.txt" title="Starter RuleSet (All)">Starter RuleSet (All)</a>
</li>
</ul>
<h5>Report Types</h5>
<ul>
<li class="none">
<a href="codenarc-HtmlReportWriter.html" title="HTML Report">HTML Report</a>
</li>
<li class="none">
<a href="codenarc-XmlReportWriter.html" title="XML Report">XML Report</a>
</li>
<li class="none">
<a href="codenarc-TextReportWriter.html" title="Text and IDE Reports">Text and IDE Reports</a>
</li>
</ul>
<h5>Sample Reports</h5>
<ul>
<li class="none">
<a href="SampleCodeNarcHtmlReport.html" title="Sample HTML Report">Sample HTML Report</a>
</li>
<li class="none">
<a href="SampleCodeNarcXmlReport.xml" title="Sample XML Report">Sample XML Report</a>
</li>
</ul>
<h5>Rules</h5>
<ul>
<li class="none">
<a href="codenarc-rule-index.html" title="Rule Index">Rule Index</a>
</li>
<li class="none">
<a href="codenarc-rules-basic.html" title="Basic Rules">Basic Rules</a>
</li>
<li class="none">
<a href="codenarc-rules-braces.html" title="Braces Rules">Braces Rules</a>
</li>
<li class="none">
<a href="codenarc-rules-concurrency.html" title="Concurrency Rules">Concurrency Rules</a>
</li>
<li class="none">
<a href="codenarc-rules-convention.html" title="Convention Rules">Convention Rules</a>
</li>
<li class="none">
<a href="codenarc-rules-design.html" title="Design Rules">Design Rules</a>
</li>
<li class="none">
<a href="codenarc-rules-dry.html" title="DRY Rules">DRY Rules</a>
</li>
<li class="none">
<a href="codenarc-rules-enhanced.html" title="Enhanced Rules">Enhanced Rules</a>
</li>
<li class="none">
<a href="codenarc-rules-exceptions.html" title="Exceptions Rules">Exceptions Rules</a>
</li>
<li class="none">
<a href="codenarc-rules-formatting.html" title="Formatting Rules">Formatting Rules</a>
</li>
<li class="none">
<a href="codenarc-rules-generic.html" title="Generic Rules">Generic Rules</a>
</li>
<li class="none">
<a href="codenarc-rules-grails.html" title="Grails Rules">Grails Rules</a>
</li>
<li class="none">
<a href="codenarc-rules-groovyism.html" title="Groovyism Rules">Groovyism Rules</a>
</li>
<li class="none">
<a href="codenarc-rules-imports.html" title="Imports Rules">Imports Rules</a>
</li>
<li class="none">
<a href="codenarc-rules-jdbc.html" title="JDBC Rules">JDBC Rules</a>
</li>
<li class="none">
<a href="codenarc-rules-junit.html" title="JUnit Rules">JUnit Rules</a>
</li>
<li class="none">
<a href="codenarc-rules-logging.html" title="Logging Rules">Logging Rules</a>
</li>
<li class="none">
<strong>Naming Rules</strong>
</li>
<li class="none">
<a href="codenarc-rules-size.html" title="Size/Complexity Rules">Size/Complexity Rules</a>
</li>
<li class="none">
<a href="codenarc-rules-security.html" title="Security Rules">Security Rules</a>
</li>
<li class="none">
<a href="codenarc-rules-serialization.html" title="Serialization Rules">Serialization Rules</a>
</li>
<li class="none">
<a href="codenarc-rules-unnecessary.html" title="Unnecessary Rules">Unnecessary Rules</a>
</li>
<li class="none">
<a href="codenarc-rules-unused.html" title="Unused Rules">Unused Rules</a>
</li>
</ul>
<h5>Developing</h5>
<ul>
<li class="none">
<a href="codenarc-developer-guide.html" title="Developer Guide">Developer Guide</a>
</li>
</ul>
<h5>Project Documentation</h5>
<ul>
<li class="collapsed">
<a href="project-info.html" title="Project Information">Project Information</a>
</li>
<li class="collapsed">
<a href="project-reports.html" title="Project Reports">Project Reports</a>
</li>
</ul>
<a href="http://sourceforge.net" title="Hosted on SourceForge.net" class="poweredBy">
<img class="poweredBy" alt="Hosted on SourceForge.net" src="http://sflogo.sourceforge.net/sflogo.php?group_id=208647&type=2" />
</a>
<a href="http://maven.apache.org" title="Build with Maven 2" class="poweredBy">
<img class="poweredBy" alt="Build with Maven 2" src="images/logos/maven-feather.png" />
</a>
</div>
</div>
<div id="bodyColumn">
<div id="contentBox">
<div class="section">
<h2>Naming Rules ("<i>rulesets/naming.xml</i>")<a name="Naming_Rules_rulesetsnaming.xml"></a></h2><!-- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -->
<div class="section">
<h3><a name="AbstractClassName">AbstractClassName</a> Rule<a name="AbstractClassName_Rule"></a></h3><!-- ~~~~~~~~~~~~~~~~~~~~~~~ -->
<p>Verifies that the name of an abstract class matches the regular expression specified in the <b>regex</b> property. If that property is null or empty, then this rule is not applied (i.e., it does nothing). It defaults to null, so this rule must be explicitly configured to be active. This rule ignores interfaces and is applied only to abstract classes.</p>
<table border="1" class="bodyTable">
<tr class="a">
<td align="left"><b>Property</b></td>
<td align="left"><b>Description</b></td>
<td align="left"><b>Default Value</b></td></tr>
<tr class="b">
<td align="left">regex</td>
<td align="left">Specifies the regular expression used to validate the abstract class name. If null or empty, then this rule does nothing.</td>
<td align="left"><tt>null</tt></td></tr></table></div>
<div class="section">
<h3><a name="ClassName">ClassName</a> Rule<a name="ClassName_Rule"></a></h3><!-- ~~~~~~~~~~~~~~~ -->
<p>Verifies that the name of a class matches a regular expression. By default it checks that the class name starts with an uppercase letter and is followed by zero or more word characters (letters, numbers or underscores) or dollar signs ($).</p>
<table border="1" class="bodyTable">
<tr class="a">
<td align="left"><b>Property</b></td>
<td align="left"><b>Description</b></td>
<td align="left"><b>Default Value</b></td></tr>
<tr class="b">
<td align="left">regex</td>
<td align="left">Specifies the regular expression used to validate the class name. It is required and cannot be null or empty.</td>
<td align="left">/([A-Z] w* $?)*/</td></tr></table></div>
<div class="section">
<h3><a name="ClassNameSameAsFilename">ClassNameSameAsFilename</a> Rule<a name="ClassNameSameAsFilename_Rule"></a></h3><!-- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -->
<p><i>Since CodeNarc 0.19</i></p>
<p>Reports files containing only one top level class / enum / interface which is named differently than the file.</p></div>
<div class="section">
<h3><a name="ConfusingMethodName">ConfusingMethodName</a> Rule<a name="ConfusingMethodName_Rule"></a></h3><!-- ~~~~~~~~~~~~~~~~~~~~~~~~~ -->
<p><i>Since CodeNarc 0.11</i></p>
<p>Checks for very confusing method names. The referenced methods have names that differ only by capitalization. This is very confusing because if the capitalization were identical then one of the methods would override the other.</p>
<p>Also, violations are triggered when methods and fields have very similar names.</p>
<div>
<pre> class MyClass {
int total
int total() {
1
}
}
</pre></div></div>
<div class="section">
<h3><a name="FactoryMethodName">FactoryMethodName</a> Rule<a name="FactoryMethodName_Rule"></a></h3><!-- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -->
<p><i>Since CodeNarc 0.16</i></p>
<p>A factory method is a method that creates objects, and they are typically named either buildFoo(), makeFoo(), or createFoo(). This rule enforces that only one naming convention is used. It defaults to allowing makeFoo(), but that can be changed using the property <tt>regex</tt>. The regex is a negative expression; it specifically bans methods named build* or create*. However, methods named build or build* receive some special treatment because of the popular Builder Pattern. If the 'build' method is in a class named *Builder then it does not cause a violation. </p>
<p>Builder methods are slightly different than factory methods.</p>
<table border="1" class="bodyTable">
<tr class="a">
<td align="left"><b>Property</b></td>
<td align="left"><b>Description</b></td>
<td align="left"><b>Default Value</b></td></tr>
<tr class="b">
<td align="left">regex</td>
<td align="left">Specifies the default regular expression used to validate the method name. It is required and cannot be null or empty.</td>
<td align="left">/(build.*|create.*)/</td></tr></table>
<p>Example of violations:</p>
<div>
<pre> class MyClass {
// violation. Factory methods should be named make()
def create() {
}
// violation. Factory methods should be named make()
def createSomething() {
}
// violation. Builder method not in class named *Builder
def build() {
}
// violation. Builder method not in class named *Builder
def buildSomething() {
}
// this is OK because it is called make
def make() {
}
// this is also OK
def makeSomething() {
}
// OK, overriding a parent
@Override
build() { }
}
class WidgetBuilder {
// OK, the class name ends in Builder
def build() {
}
}
</pre></div></div>
<div class="section">
<h3><a name="FieldName">FieldName</a> Rule<a name="FieldName_Rule"></a></h3><!-- ~~~~~~~~~~~~~~~ -->
<p>Verifies that the name of each field matches a regular expression. By default it checks that fields that are not <i>static final</i> have field names that start with a lowercase letter and contains only letters or numbers. By default, <i>static final</i> field names start with an uppercase letter and contain only uppercase letters, numbers and underscores.</p>
<p><b>NOTE:</b> This rule checks only regular <i>fields</i> of a class, not <i>properties</i>. In Groovy, <i>properties</i> are fields declared with no access modifier (public, protected, private). Thus, this rule only checks fields that specify an access modifier. For naming of <i>properties</i>, see <tt>PropertyNameRule</tt>.</p>
<table border="1" class="bodyTable">
<tr class="a">
<td align="left"><b>Property</b></td>
<td align="left"><b>Description</b></td>
<td align="left"><b>Default Value</b></td></tr>
<tr class="b">
<td align="left">regex</td>
<td align="left">Specifies the default regular expression used to validate the field name. It is required and cannot be null or empty.</td>
<td align="left">/[a-z][a-zA-Z0-9]*/</td></tr>
<tr class="a">
<td align="left">finalRegex</td>
<td align="left">Specifies the regular expression used to validate <tt>final</tt> field names. It is optional. If not set, then <tt>final</tt> fields that are non-<tt>static</tt> are validated using <b>regex</b>.</td>
<td align="left"><tt>null</tt></td></tr>
<tr class="b">
<td align="left">staticRegex</td>
<td align="left">Specifies the regular expression used to validate <tt>static</tt> field names. It is optional. If not set, then <tt>static</tt> fields that are non-<tt>final</tt> are validated using <b>regex</b>.</td>
<td align="left"><tt>null</tt></td></tr>
<tr class="a">
<td align="left">staticFinalRegex</td>
<td align="left">Specifies the regular expression used to validate <tt>static final</tt> field names. It is optional. If not set, then <tt>static final</tt> fields are validated using <b>finalRegex</b>, <b>staticRegex</b> or <b>regex</b>.</td>
<td align="left">/[A-Z][A-Z0-9_]*/</td></tr>
<tr class="b">
<td align="left">ignoreFieldNames</td>
<td align="left">Specifies one or more (comma-separated) field names that should be ignored (i.e., that should not cause a rule violation). The names may optionally contain wildcards (*,?).</td>
<td align="left">serialVersionUID</td></tr></table>
<p>The order of precedence for the regular expression properties is: <b>staticFinalRegex</b>, <b>finalRegex</b>, <b>staticRegex</b> and finally <b>regex</b>. In other words, the first regex in that list matching the modifiers for the field is the one that is applied for the field name validation.</p></div>
<div class="section">
<h3><a name="InterfaceName">InterfaceName</a> Rule<a name="InterfaceName_Rule"></a></h3><!-- ~~~~~~~~~~~~~~~~~~~~~~~ -->
<p>Verifies that the name of an interface matches the regular expression specified in the <b>regex</b> property. If that property is null or empty, then this rule is not applied (i.e., it does nothing). It defaults to null, so this rule must be explicitly configured to be active.</p>
<table border="1" class="bodyTable">
<tr class="a">
<td align="left"><b>Property</b></td>
<td align="left"><b>Description</b></td>
<td align="left"><b>Default Value</b></td></tr>
<tr class="b">
<td align="left">regex</td>
<td align="left">Specifies the regular expression used to validate the name of an interface. If null or empty, then this rule does nothing.</td>
<td align="left"><tt>null</tt></td></tr></table></div>
<div class="section">
<h3><a name="MethodName">MethodName</a> Rule<a name="MethodName_Rule"></a></h3><!-- ~~~~~~~~~~~~~~~~ -->
<p>Verifies that the name of each method matches a regular expression. By default it checks that the method name starts with a lowercase letter. Implicit method names are ignored (i.e., 'main' and 'run' methods automatically created for Groovy scripts).</p>
<table border="1" class="bodyTable">
<tr class="a">
<td align="left"><b>Property</b></td>
<td align="left"><b>Description</b></td>
<td align="left"><b>Default Value</b></td></tr>
<tr class="b">
<td align="left">regex</td>
<td align="left">Specifies the regular expression used to validate the method name. It is required and cannot be null or empty.</td>
<td align="left">/[a-z] w*/</td></tr>
<tr class="a">
<td align="left">ignoreMethodNames</td>
<td align="left">Specifies one or more (comma-separated) method names that should be ignored (i.e., that should not cause a rule violation). The names may optionally contain wildcards (*,?).</td>
<td align="left"><tt>null</tt></td></tr></table></div>
<div class="section">
<h3><a name="ObjectOverrideMisspelledMethodName">ObjectOverrideMisspelledMethodName</a> Rule<a name="ObjectOverrideMisspelledMethodName_Rule"></a></h3><!-- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -->
<p><i>Since CodeNarc 0.11</i></p>
<p>Verifies that the names of the most commonly overridden methods of <tt>Object</tt>: <tt>equals</tt>, <tt>hashCode</tt> and <tt>toString</tt>, are correct.</p>
<p>Here are some examples of code that produces violations:</p>
<div>
<pre> boolean equal(Object o) {} // violation
boolean equal(int other) {} // ok; wrong param type
boolean equal(Object o, int other) {} // ok; too many params
boolean equaLS(Object o) {} // violation
int hashcode() {} // violation
int hashCOde() {} // violation
int hashcode(int value) {} // ok; not empty params
String tostring() {} // violation
String toSTring() {} // violation
String tostring(int value) {} // ok; not empty params
</pre></div></div>
<div class="section">
<h3><a name="PackageName">PackageName</a> Rule<a name="PackageName_Rule"></a></h3><!-- ~~~~~~~~~~~~~~~~~ -->
<p>Verifies that the package name of a class matches a regular expression. By default it checks that the package name consists of only lowercase letters and numbers, separated by periods.</p>
<table border="1" class="bodyTable">
<tr class="a">
<td align="left"><b>Property</b></td>
<td align="left"><b>Description</b></td>
<td align="left"><b>Default Value</b></td></tr>
<tr class="b">
<td align="left">regex</td>
<td align="left">Specifies the regular expression used to validate the package name. It is required and cannot be null or empty.</td>
<td align="left">/[a-z]+[a-z0-9]*( .[a-z0-9]+)*/</td></tr>
<tr class="a">
<td align="left">packageNameRequired</td>
<td align="left">Indicates whether a package name declaration is required for all classes.</td>
<td align="left"><tt>false</tt></td></tr></table></div>
<div class="section">
<h3><a name="PackageNameMatchesFilePath">PackageNameMatchesFilePath</a> Rule<a name="PackageNameMatchesFilePath_Rule"></a></h3><!-- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -->
<p><i>Since CodeNarc 0.22</i></p>
<p>A package source file's path should match the package declaration.</p>
<table border="1" class="bodyTable">
<tr class="a">
<td align="left"><b>Property</b></td>
<td align="left"><b>Description</b></td>
<td align="left"><b>Default Value</b></td></tr>
<tr class="b">
<td align="left">groupId</td>
<td align="left">Specifies the common <i>group id</i> part of a package name, that will appear within all checked package names. It must also map to the file path for the corresponding source file. For instance, a <i>groupId</i> of <i>"org.sample"</i> means that for all classes that specify a package, that package name must include <i>"org.sample"</i>, and the source file must exist under an "org/sample" directory. Then, a <tt>MyClass</tt> class in a <tt>org.sample.util</tt> package must be defined in a "MyClass.groovy" file within a <i>"org/sample/util"</i> directory. That directory can be the child of any arbitrary <i>root path</i>, e.g. "src/main/groovy". To find the sub-path relevant for the package the rule searches for the first appearance of <i>groupId</i> in the file path. It's <i>required</i> to configure this. If <tt>groupId</tt> is null or empty, this rule does nothing.</td>
<td align="left"><tt>null</tt></td></tr></table></div>
<div class="section">
<h3><a name="ParameterName">ParameterName</a> Rule<a name="ParameterName_Rule"></a></h3><!-- ~~~~~~~~~~~~~~~~~~~ -->
<p>Verifies that the name of each parameter matches a regular expression. This rule applies to method parameters, constructor parameters and closure parameters. By default it checks that parameter names start with a lowercase letter and contains only letters or numbers.</p>
<table border="1" class="bodyTable">
<tr class="a">
<td align="left"><b>Property</b></td>
<td align="left"><b>Description</b></td>
<td align="left"><b>Default Value</b></td></tr>
<tr class="b">
<td align="left">regex</td>
<td align="left">Specifies the regular expression used to validate the parameter name. It is required and cannot be null or empty.</td>
<td align="left">/[a-z][a-zA-Z0-9]*/</td></tr>
<tr class="a">
<td align="left">ignoreParameterNames</td>
<td align="left">Specifies one or more (comma-separated) parameter names that should be ignored (i.e., that should not cause a rule violation). The names may optionally contain wildcards (*,?).</td>
<td align="left"><tt>null</tt></td></tr></table></div>
<div class="section">
<h3><a name="PropertyName">PropertyName</a> Rule<a name="PropertyName_Rule"></a></h3><!-- ~~~~~~~~~~~~~~~~~~ -->
<p>Verifies that the name of each property matches a regular expression. By default it checks that property names (other than <i>static final</i>) start with a lowercase letter and contains only letters or numbers. By default, <i>static final</i> property names start with an uppercase letter and contain only uppercase letters, numbers and underscores.</p>
<p><b>NOTE:</b> This rule checks only <i>properties</i> of a class, not regular <i>fields</i>. In Groovy, <i>properties</i> are fields declared with no access modifier (public, protected, private). For naming of regular <i>fields</i>, see <tt>FieldNameRule</tt>.</p>
<table border="1" class="bodyTable">
<tr class="a">
<td align="left"><b>Property</b></td>
<td align="left"><b>Description</b></td>
<td align="left"><b>Default Value</b></td></tr>
<tr class="b">
<td align="left">regex</td>
<td align="left">Specifies the default regular expression used to validate the property name. It is required and cannot be null or empty.</td>
<td align="left">/[a-z][a-zA-Z0-9]*/</td></tr>
<tr class="a">
<td align="left">finalRegex</td>
<td align="left">Specifies the regular expression used to validate <tt>final</tt> property names. It is optional. If not set, then <tt>final</tt> properties that are non-<tt>static</tt> are validated using <b>regex</b>.</td>
<td align="left"><tt>null</tt></td></tr>
<tr class="b">
<td align="left">staticRegex</td>
<td align="left">Specifies the regular expression used to validate <tt>static</tt> property names. It is optional. If not set, then <tt>static</tt> properties that are non-<tt>final</tt> are validated using <b>regex</b>.</td>
<td align="left"><tt>null</tt></td></tr>
<tr class="a">
<td align="left">staticFinalRegex</td>
<td align="left">Specifies the regular expression used to validate <tt>static final</tt> property names. It is optional. If not set, then <tt>static final</tt> property are validated using <b>finalRegex</b>, <b>staticRegex</b> or <b>regex</b>.</td>
<td align="left">/[A-Z][A-Z0-9_]*/</td></tr>
<tr class="b">
<td align="left">ignorePropertyNames</td>
<td align="left">Specifies one or more (comma-separated) property names that should be ignored (i.e., that should not cause a rule violation). The names may optionally contain wildcards (*,?).</td>
<td align="left"><tt>null</tt></td></tr></table>
<p>The order of precedence for the regular expression properties is: <b>staticFinalRegex</b>, <b>finalRegex</b>, <b>staticRegex</b> and finally <b>regex</b>. In other words, the first regex in that list matching the modifiers for the property is the one that is applied for the field name validation.</p></div>
<div class="section">
<h3><a name="VariableName">VariableName</a> Rule<a name="VariableName_Rule"></a></h3><!-- ~~~~~~~~~~~~~~~~~~ -->
<p>Verifies that the name of each variable matches a regular expression. By default it checks that non-<tt>final</tt> variable names start with a lowercase letter and contains only letters or numbers. By default, <tt>final</tt> variable names start with an uppercase letter and contain only uppercase letters, numbers and underscores.</p>
<table border="1" class="bodyTable">
<tr class="a">
<td align="left"><b>Property</b></td>
<td align="left"><b>Description</b></td>
<td align="left"><b>Default Value</b></td></tr>
<tr class="b">
<td align="left">regex</td>
<td align="left">Specifies the default regular expression used to validate the variable name. It is required and cannot be null or empty.</td>
<td align="left">/[a-z][a-zA-Z0-9]*/</td></tr>
<tr class="a">
<td align="left">finalRegex</td>
<td align="left">Specifies the regular expression used to validate <tt>final</tt> variable names. It is optional. If not set, then <b>regex</b> is used to validate <tt>final</tt> variable names.</td>
<td align="left">/[A-Z][A-Z0-9_]*/</td></tr>
<tr class="b">
<td align="left">ignoreVariableNames</td>
<td align="left">Specifies one or more (comma-separated) variable names that should be ignored (i.e., that should not cause a rule violation). The names may optionally contain wildcards (*,?).</td>
<td align="left"><tt>null</tt></td></tr></table></div></div>
</div>
</div>
<div class="clear">
<hr/>
</div>
<div id="footer">
<div class="xright">
Copyright © 2015.
All Rights Reserved.
</div>
<div class="clear">
<hr/>
</div>
</div>
</body>
</html>
|
