KickJava   Java API By Example, From Geeks To Geeks.

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


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.Scope;
23 import com.puppycrawl.tools.checkstyle.api.ScopeUtils;
24 import com.puppycrawl.tools.checkstyle.api.TokenTypes;
25
26
27 /**
28  * <p>Checks that a private field is used.
29  * </p>
30  * <p>
31  * An example of how to configure the check is:
32  * </p>
33  * <pre>
34  * &lt;module name="usage.UnusedPrivateField"/&gt;
35  * </pre>
36  *
37  * @author Rick Giles
38  */
39 public class UnusedPrivateFieldCheck
40     extends AbstractUsageCheck
41 {
42     /** @see com.puppycrawl.tools.checkstyle.api.Check */
43     public int[] getDefaultTokens()
44     {
45         return new int[] {
46             TokenTypes.VARIABLE_DEF,
47         };
48     }
49
50     /** @see com.puppycrawl.tools.checkstyle.checks.usage.AbstractUsageCheck */
51     public String JavaDoc getErrorKey()
52     {
53         return "unused.field";
54     }
55
56     /** @see com.puppycrawl.tools.checkstyle.checks.usage.AbstractUsageCheck */
57     public boolean mustCheckReferenceCount(DetailAST aAST)
58     {
59         final DetailAST mods = aAST.findFirstToken(TokenTypes.MODIFIERS);
60         return ((mods != null)
61             && (ScopeUtils.getScopeFromMods(mods) == Scope.PRIVATE));
62     }
63 }
64
Popular Tags