KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > puppycrawl > tools > checkstyle > checks > coding > MissingCtorCheck


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.coding;
20
21 import com.puppycrawl.tools.checkstyle.api.DetailAST;
22 import com.puppycrawl.tools.checkstyle.api.TokenTypes;
23
24 import com.puppycrawl.tools.checkstyle.checks.DescendantTokenCheck;
25
26 /**
27  * <p>
28  * Checks that classes (except abstract one) define a ctor and don't rely
29  * on the default one.
30  * </p>
31  * <p>
32  * An example of how to configure the check is:
33  * </p>
34  * <pre>
35  * &lt;module name="MissingCtor"/&gt;
36  * </pre>
37  *
38  * @author o_sukhodolsky
39  */
40 public class MissingCtorCheck extends DescendantTokenCheck
41 {
42     /** Creates new instance of the check. */
43     public MissingCtorCheck()
44     {
45         setLimitedTokens(new String JavaDoc[] {
46             TokenTypes.getTokenName(TokenTypes.CTOR_DEF),
47         });
48         setMinimumNumber(1);
49         setMaximumDepth(2);
50         setMinimumMessage("missing.ctor");
51     }
52
53     /** {@inheritDoc} */
54     public int[] getDefaultTokens()
55     {
56         return new int[]{TokenTypes.CLASS_DEF};
57     }
58
59     /** {@inheritDoc} */
60     public int[] getAcceptableTokens()
61     {
62         return getDefaultTokens();
63     }
64
65     /** {@inheritDoc} */
66     public void visitToken(DetailAST aAST)
67     {
68         final DetailAST modifiers = aAST.findFirstToken(TokenTypes.MODIFIERS);
69         if ((modifiers != null)
70             && modifiers.branchContains(TokenTypes.ABSTRACT))
71         {
72             // should apply the check to abtract class
73 return;
74         }
75
76         super.visitToken(aAST);
77     }
78 }
79
Popular Tags