KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > puppycrawl > tools > checkstyle > checks > usage > transmogrify > ReferenceThreshold


1
2 // Transmogrify License
3 //
4 // Copyright (c) 2001, ThoughtWorks, Inc.
5 // All rights reserved.
6 // Redistribution and use in source and binary forms, with or without
7 // modification, are permitted provided that the following conditions
8 // are met:
9 // - Redistributions of source code must retain the above copyright notice,
10 // this list of conditions and the following disclaimer.
11 // - Redistributions in binary form must reproduce the above copyright
12 // notice, this list of conditions and the following disclaimer in the
13 // documentation and/or other materials provided with the distribution.
14 // Neither the name of the ThoughtWorks, Inc. nor the names of its
15 // contributors may be used to endorse or promote products derived from this
16 // software without specific prior written permission.
17 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
19 // TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
20 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
21 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
22 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
23 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
24 // OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
25 // WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
26 // OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
27 // ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28
29 package com.puppycrawl.tools.checkstyle.checks.usage.transmogrify;
30
31
32 import java.util.Set JavaDoc;
33 import java.util.TreeSet JavaDoc;
34
35
36
37 public class ReferenceThreshold extends ReferenceTool {
38   private Set JavaDoc _underreferencedDefinitions;
39   private int _threshold;
40
41   public ReferenceThreshold(SymbolTable table, int threshold) {
42     super(table.getTree());
43     _threshold = threshold;
44     _underreferencedDefinitions = new TreeSet JavaDoc();
45     go();
46   }
47
48   private void go() {
49     collectUnderreferencedDefinitions();
50   }
51
52   private void collectUnderreferencedDefinitions() {
53     handleNode(_tree);
54   }
55
56   protected void handleNode(SymTabAST node) {
57     if (node.isMeaningful()) {
58       IDefinition def = node.getDefinition();
59       if (def != null &&
60           def.getNumReferences() <= _threshold &&
61           def instanceof Definition) {
62         // this is inheritently hackish
63 // basically we want to ignore
64 // all test cases and main() methods
65 if (def.getQualifiedName().indexOf("test") < 0 &&
66             def.getQualifiedName().indexOf("main") < 0) {
67           _underreferencedDefinitions.add(def);
68         }
69       }
70     }
71
72     walkChildren(node);
73   }
74
75   public Set JavaDoc getUnderreferencedDefinitions() {
76     return _underreferencedDefinitions;
77   }
78 }
79
Popular Tags