Work at SourceForge, help us to make it a better place! We have an immediate need for a Support Technician in our San Francisco or Denver office.

Close

[95a960]: docs / config_usage.html Maximize Restore History

Download this file

config_usage.html    329 lines (298 with data), 10.1 kB

  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
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>Checks for usage</title>
<link rel="stylesheet" type="text/css" href="mystyle.css"/>
</head>
<body>
<!-- The header -->
<table border="0" width="100%" summary="header layout">
<tr>
<td><h1>Checks for usage</h1></td>
<td align="right"><img src="logo.png" alt="Checkstyle Logo"/></td>
</tr>
</table>
<!-- content -->
<table border="0" width="100%" cellpadding="5" summary="body layout">
<tr>
<!--Left menu-->
<td class="menu" valign="top">
<ul>
<li>
<a href="#OneMethodPrivateField">OneMethodPrivateField</a>
</li>
<li>
<a href="#UnusedLocalVariable">UnusedLocalVariable</a>
</li>
<li>
<a href="#UnusedParameter">UnusedParameter</a>
</li>
<li>
<a href="#UnusedPrivateField">UnusedPrivateField</a>
</li>
<li>
<a href="#UnusedPrivateMethod">UnusedPrivateMethod</a>
</li>
</ul>
</td>
<!--Content-->
<td class="content" valign="top" align="left">
<a name="OneMethodPrivateField"></a> <h2>OneMethodPrivateField</h2> <h4>Description</h4>
<p class="body">
Checks that a private field is used in more than one method, constructor, or initializer.
</p>
<p class="body">
Rationale: a private field used in only one method, constructor, or
initializer should be replaced by a local variable.
</p>
<h4>Properties</h4>
<table width="100%" border="1" cellpadding="5" class="body">
<tr class="header">
<th>name</th>
<th>description</th>
<th>type</th>
<th>default value</th>
</tr>
<tr>
<td>ignoreFormat</td>
<td>pattern for field names that should be ignored</td>
<td><a href="property_types.html#regexp">regular expression</a></td>
<td><span class="default">^$</span> (empty)</td>
</tr>
</table>
<h4>Examples</h4>
<p class="body">
To configure the check:
</p>
<pre class="body">
&lt;module name=&quot;usage.OneMethodPrivateField&quot;/&gt;
</pre>
<p class="body">
To configure the check to ignore fields whose name ends in <span class="code">Temp</span>:
</p>
<pre class="body">
&lt;module name=&quot;usage.OneMethodPrivateField&quot;&gt;
&lt;property name=&quot;ignoreFormat&quot; value=&quot;Temp$&quot;/&gt;
&lt;/module&gt;
</pre>
<h4>Package</h4>
<p class="body">
com.puppycrawl.tools.checkstyle.checks.usage
</p>
<h4>Parent Module</h4>
<p class="body">
<a href="config.html#treewalker">TreeWalker</a>
</p>
<a name="UnusedLocalVariable"></a> <h2>UnusedLocalVariable</h2> <h4>Description</h4>
<p class="body">
Checks that a local variable is used after its declaration.
</p>
</p>
<h4>Properties</h4>
<table width="100%" border="1" cellpadding="5" class="body">
<tr class="header">
<th>name</th>
<th>description</th>
<th>type</th>
<th>default value</th>
</tr>
<tr>
<td>ignoreFormat</td>
<td>pattern for variable names that should be ignored</td>
<td><a href="property_types.html#regexp">regular expression</a></td>
<td><span class="default">^$</span> (empty)</td>
</tr>
</table>
<h4>Examples</h4>
<p class="body">
To configure the check:
</p>
<pre class="body">
&lt;module name=&quot;usage.UnusedLocalVariable&quot;/&gt;
</pre>
<p class="body">
To configure the check to ignore variables whose name ends in <span class="code">Temp</span>:
</p>
<pre class="body">
&lt;module name=&quot;usage.UnusedLocalVariable&quot;&gt;
&lt;property name=&quot;ignoreFormat&quot; value=&quot;Temp$&quot;/&gt;
&lt;/module&gt;
</pre>
<h4>Package</h4>
<p class="body">
com.puppycrawl.tools.checkstyle.checks.usage
</p>
<h4>Parent Module</h4>
<p class="body">
<a href="config.html#treewalker">TreeWalker</a>
</p>
<a name="UnusedParameter"></a> <h2>UnusedParameter</h2> <h4>Description</h4>
<p class="body">
Checks that a parameter is used.
</p>
</p>
<h4>Properties</h4>
<table width="100%" border="1" cellpadding="5" class="body">
<tr class="header">
<th>name</th>
<th>description</th>
<th>type</th>
<th>default value</th>
</tr>
<tr>
<td>ignoreFormat</td>
<td>pattern for parameter names that should be ignored</td>
<td><a href="property_types.html#regexp">regular expression</a></td>
<td><span class="default">^$</span> (empty)</td>
</tr>
<tr>
<td>ignoreCatch</td>
<td>controls whether <span class="code">catch</span> parameters should be ignored</td>
<td><a href="property_types.html#boolean">boolean</a></td>
<td><span class="default">true</span></td>
</tr>
<tr>
<td>ignoreNonLocal</td>
<td>controls whether parameters of non local (<span
class="code">public, protected or package</span>) methods
should be ignored</td>
<td><a href="property_types.html#boolean">boolean</a></td>
<td><span class="default">false</span></td>
</tr>
</table>
<h4>Examples</h4>
<p class="body">
To configure the check:
</p>
<pre class="body">
&lt;module name=&quot;usage.UnusedParameter&quot;/&gt;
</pre>
<p class="body">
To configure the check to ignore parameters whose name ends in <span class="code">Temp</span>:
</p>
<pre class="body">
&lt;module name=&quot;usage.UnusedParameter&quot;&gt;
&lt;property name=&quot;ignoreFormat&quot; value=&quot;Temp$&quot;/&gt;
&lt;/module&gt;
</pre>
<p class="body">
To configure the check to report unused <span class="code">catch</span> parameters:
</p>
<pre class="body">
&lt;module name=&quot;usage.UnusedParameter&quot;&gt;
&lt;property name=&quot;ignoreCatch&quot; value=&quot;false&quot;/&gt;
&lt;/module&gt;
</pre>
<h4>Package</h4>
<p class="body">
com.puppycrawl.tools.checkstyle.checks.usage
</p>
<h4>Parent Module</h4>
<p class="body">
<a href="config.html#treewalker">TreeWalker</a>
</p>
<a name="UnusedPrivateField"></a> <h2>UnusedPrivateField</h2> <h4>Description</h4>
<p class="body">
Checks that a private field is used.
</p>
</p>
<h4>Properties</h4>
<table width="100%" border="1" cellpadding="5" class="body">
<tr class="header">
<th>name</th>
<th>description</th>
<th>type</th>
<th>default value</th>
</tr>
<tr>
<td>ignoreFormat</td>
<td>pattern for field names that should be ignored</td>
<td><a href="property_types.html#regexp">regular expression</a></td>
<td><span class="default">^$</span> (empty)</td>
</tr>
</table>
<h4>Examples</h4>
<p class="body">
To configure the check:
</p>
<pre class="body">
&lt;module name=&quot;usage.UnusedPrivateField&quot;/&gt;
</pre>
<p class="body">
To configure the check to ignore fields whose name ends in <span class="code">Temp</span>:
</p>
<pre class="body">
&lt;module name=&quot;usage.UnusedPrivateField&quot;&gt;
&lt;property name=&quot;ignoreFormat&quot; value=&quot;Temp$&quot;/&gt;
&lt;/module&gt;
</pre>
<h4>Package</h4>
<p class="body">
com.puppycrawl.tools.checkstyle.checks.usage
</p>
<h4>Parent Module</h4>
<p class="body">
<a href="config.html#treewalker">TreeWalker</a>
</p>
<a name="UnusedPrivateMethod"></a> <h2>UnusedPrivateMethod</h2> <h4>Description</h4>
<p class="body">
Checks that a private method is used.
</p>
</p>
<h4>Properties</h4>
<table width="100%" border="1" cellpadding="5" class="body">
<tr class="header">
<th>name</th>
<th>description</th>
<th>type</th>
<th>default value</th>
</tr>
<tr>
<td>ignoreFormat</td>
<td>pattern for method names that should be ignored</td>
<td><a href="property_types.html#regexp">regular expression</a></td>
<td><span class="default">^$</span> (empty)</td>
</tr>
</table>
<h4>Examples</h4>
<p class="body">
To configure the check:
</p>
<pre class="body">
&lt;module name=&quot;usage.UnusedPrivateMethod&quot;/&gt;
</pre>
<p class="body">
To configure the check to ignore methods whose name ends in <span class="code">Temp</span>:
</p>
<pre class="body">
&lt;module name=&quot;usage.UnusedPrivateMethod&quot;&gt;
&lt;property name=&quot;ignoreFormat&quot; value=&quot;Temp$&quot;/&gt;
&lt;/module&gt;
</pre>
<h4>Notes</h4>
<ul class="body">
<li>The classpath may need to be configured to locate parameter type information. The
classpath configuration is dependent on the mechanism used to invoke Checkstyle.
</li>
</ul>
<h4>Package</h4>
<p class="body">
com.puppycrawl.tools.checkstyle.checks.usage
</p>
<h4>Parent Module</h4>
<p class="body">
<a href="config.html#treewalker">TreeWalker</a>
</p>
</td>
</tr>
</table>
<hr />
<div><a href="index.html">Back to the Checkstyle Home Page</a></div>
<p class="copyright">
Copyright &copy; 2002-2004 Oliver Burn. All rights Reserved.
</p>
</body>
</html>