KickJava   Java API By Example, From Geeks To Geeks.

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


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.Check;
22 import com.puppycrawl.tools.checkstyle.api.DetailAST;
23 import com.puppycrawl.tools.checkstyle.api.TokenTypes;
24
25 /**
26  * Ensures there is a package declaration.
27  * Rationale: Classes that live in the null package cannot be
28  * imported. Many novice developers are not aware of this.
29  *
30  * @author <a HREF="mailto:simon@redhillconsulting.com.au">Simon Harris</a>
31  */
32 public final class PackageDeclarationCheck extends Check
33 {
34     /** is package defined. */
35     private boolean mDefined;
36
37     /** {@inheritDoc} */
38     public int[] getDefaultTokens()
39     {
40         return new int[] {TokenTypes.PACKAGE_DEF};
41     }
42
43     /** {@inheritDoc} */
44     public int[] getRequiredTokens()
45     {
46         return getDefaultTokens();
47     }
48
49     /** {@inheritDoc} */
50     public void beginTree(DetailAST aAST)
51     {
52         mDefined = false;
53     }
54
55     /** {@inheritDoc} */
56     public void finishTree(DetailAST aAST)
57     {
58         if (!mDefined) {
59             log(aAST.getLineNo(), "missing.package.declaration");
60         }
61     }
62
63     /** {@inheritDoc} */
64     public void visitToken(DetailAST aAST)
65     {
66         mDefined = true;
67     }
68 }
69
Popular Tags