01: ////////////////////////////////////////////////////////////////////////////////
02: // checkstyle: Checks Java source code for adherence to a set of rules.
03: // Copyright (C) 2001-2005 Oliver Burn
04: //
05: // This library is free software; you can redistribute it and/or
06: // modify it under the terms of the GNU Lesser General Public
07: // License as published by the Free Software Foundation; either
08: // version 2.1 of the License, or (at your option) any later version.
09: //
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: * <p>Checks that a local variable is read.
27: * </p>
28: * <p>
29: * An example of how to configure the check is:
30: * </p>
31: * <pre>
32: * <module name="usage.UnusedLocalVariable"/>
33: * </pre>
34: *
35: * @author Rick Giles
36: */
37: public class UnusedLocalVariableCheck extends AbstractUsageCheck {
38: /** @see com.puppycrawl.tools.checkstyle.api.Check */
39: public int[] getDefaultTokens() {
40: return new int[] { TokenTypes.VARIABLE_DEF, };
41: }
42:
43: /** @see com.puppycrawl.tools.checkstyle.checks.usage.AbstractUsageCheck */
44: public String getErrorKey() {
45: return "unused.local";
46: }
47:
48: /** @see com.puppycrawl.tools.checkstyle.checks.usage.AbstractUsageCheck */
49: public boolean mustCheckReferenceCount(DetailAST aAST) {
50: return ScopeUtils.isLocalVariableDef(aAST);
51: }
52: }
|