KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > puppycrawl > tools > checkstyle > checks > j2ee > HomeInterfaceMethodChecker


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.j2ee;
20
21 import com.puppycrawl.tools.checkstyle.api.DetailAST;
22 import com.puppycrawl.tools.checkstyle.api.TokenTypes;
23
24 /**
25  * Checks the methods of a home interface.
26  * @author Rick Giles
27  */
28 public abstract class HomeInterfaceMethodChecker
29     extends MethodChecker
30 {
31     /**
32      * Constructs a method checker for a home interface check.
33      * @param aCheck the home interface check.
34      */
35     public HomeInterfaceMethodChecker(AbstractInterfaceCheck aCheck)
36     {
37         super(aCheck);
38     }
39
40     /**
41      * {@inheritDoc}
42      */
43     public void checkMethod(DetailAST aMethodAST)
44     {
45         // every kind of a home interface has create<METHOD>(...)
46 // and find<METHOD>(...) requirements
47 final DetailAST nameAST = aMethodAST.findFirstToken(TokenTypes.IDENT);
48         final String JavaDoc name = nameAST.getText();
49         if (name.startsWith("create")) {
50             checkCreateMethod(aMethodAST);
51         }
52     }
53
54     /**
55       * Checks create&lt;METHOD&gt;(...) method requirements.
56       * @param aMethodAST the AST for the method definition.
57       */
58     protected void checkCreateMethod(DetailAST aMethodAST)
59     {
60         // return type is the entity bean’s remote or local interface
61 if (Utils.isVoid(aMethodAST)) {
62             logName(aMethodAST, "voidmethod.bean", new Object JavaDoc[] {});
63         }
64
65         // every create method throws a javax.ejb.CreateException
66 checkThrows(aMethodAST, "javax.ejb.CreateException");
67     }
68 }
69
Popular Tags