KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > puppycrawl > tools > checkstyle > checks > usage > UnusedLocalVariableCheck


1 ////////////////////////////////////////////////////////////////////////////////
2 // checkstyle: Checks Java source code for adherence to a set of rules.
3 // Copyright (C) 2001-2005 Oliver Burn
4 //
5 // This library is free software; you can redistribute it and/or
6 // modify it under the terms of the GNU Lesser General Public
7 // License as published by the Free Software Foundation; either
8 // version 2.1 of the License, or (at your option) any later version.
9 //
10 // This library is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 // Lesser General Public License for more details.
14 //
15 // You should have received a copy of the GNU Lesser General Public
16 // License along with this library; if not, write to the Free Software
17 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18 ////////////////////////////////////////////////////////////////////////////////
19 package com.puppycrawl.tools.checkstyle.checks.usage;
20
21 import com.puppycrawl.tools.checkstyle.api.DetailAST;
22 import com.puppycrawl.tools.checkstyle.api.ScopeUtils;
23 import com.puppycrawl.tools.checkstyle.api.TokenTypes;
24
25
26 /**
27  * <p>Checks that a local variable is read.
28  * </p>
29  * <p>
30  * An example of how to configure the check is:
31  * </p>
32  * <pre>
33  * &lt;module name="usage.UnusedLocalVariable"/&gt;
34  * </pre>
35  *
36  * @author Rick Giles
37  */
38 public class UnusedLocalVariableCheck extends AbstractUsageCheck
39 {
40     /** @see com.puppycrawl.tools.checkstyle.api.Check */
41     public int[] getDefaultTokens()
42     {
43         return new int[] {
44             TokenTypes.VARIABLE_DEF,
45         };
46     }
47
48     /** @see com.puppycrawl.tools.checkstyle.checks.usage.AbstractUsageCheck */
49     public String JavaDoc getErrorKey()
50     {
51         return "unused.local";
52     }
53
54     /** @see com.puppycrawl.tools.checkstyle.checks.usage.AbstractUsageCheck */
55     public boolean mustCheckReferenceCount(DetailAST aAST)
56     {
57         return ScopeUtils.isLocalVariableDef(aAST);
58     }
59 }
60
Popular Tags