KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > puppycrawl > tools > checkstyle > checks > metrics > ClassFanOutComplexityCheck


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.metrics;
20
21 import com.puppycrawl.tools.checkstyle.api.TokenTypes;
22
23 /**
24  * The number of other classes a given class relies on. Also the square
25  * of this has been shown to indicate the amount of maintenence required
26  * in functional programs (on a file basis) at least.
27  *
28  * @author <a HREF="mailto:simon@redhillconsulting.com.au">Simon Harris</a>
29  * @author o_sukhodolsky
30  */
31 public final class ClassFanOutComplexityCheck extends AbstractClassCouplingCheck
32 {
33     /** default value of max value. */
34     private static final int DEFAULT_MAX = 20;
35
36     /** Creates new instance of this check. */
37     public ClassFanOutComplexityCheck()
38     {
39         super(DEFAULT_MAX);
40     }
41
42     /** {@inheritDoc} */
43     public int[] getRequiredTokens()
44     {
45         return new int[] {
46             TokenTypes.PACKAGE_DEF,
47             TokenTypes.CLASS_DEF,
48             TokenTypes.INTERFACE_DEF,
49             TokenTypes.ENUM_DEF,
50             TokenTypes.TYPE,
51             TokenTypes.LITERAL_NEW,
52             TokenTypes.LITERAL_THROWS,
53             TokenTypes.ANNOTATION_DEF,
54         };
55     }
56
57     /** {@inheritDoc} */
58     protected String JavaDoc getLogMessageId()
59     {
60         return "classFanOutComplexity";
61     }
62 }
63
Popular Tags