KickJava   Java API By Example, From Geeks To Geeks.

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


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 message bean.
26  * Reference: Enterprise JavaBeansTM Specification,Version 2.0, section 15.7.
27  * @author Rick Giles
28  */
29 public class MessageBeanMethodChecker
30     extends BeanMethodChecker
31 {
32     /**
33      * Constructs a <code>MessageBeanMethodChecker</code>.
34      * @param aCheck the message bean check.
35      */
36     public MessageBeanMethodChecker(MessageBeanCheck aCheck)
37     {
38         super(aCheck);
39     }
40
41     /** true if the message bean has an ejbCreate() method */
42     private boolean mHasEjbCreate;
43
44     /**
45      * {@inheritDoc}
46      */
47     public void checkMethods(DetailAST aAST)
48     {
49         mHasEjbCreate = false;
50
51         super.checkMethods(aAST);
52
53         if (!mHasEjbCreate) {
54             final DetailAST nameAST = aAST.findFirstToken(TokenTypes.IDENT);
55             final String JavaDoc name = nameAST.getText();
56             final String JavaDoc arg = "Message bean '" + name + "'";
57             log(aAST, "missingmethod.bean",
58                 new Object JavaDoc[] {arg, "ejbCreate()"});
59         }
60     }
61
62     /**
63      * {@inheritDoc}
64      */
65     protected void checkCreateMethod(DetailAST aMethodAST)
66     {
67         final DetailAST nameAST = aMethodAST.findFirstToken(TokenTypes.IDENT);
68         final String JavaDoc name = nameAST.getText();
69         if (name.equals("ejbCreate")) {
70             super.checkCreateMethod(aMethodAST);
71             mHasEjbCreate = true;
72
73             // the return type must be void
74 if (!Utils.isVoid(aMethodAST)) {
75                 logName(aMethodAST, "nonvoidmethod.bean", new Object JavaDoc[] {});
76             }
77
78             // the method must have no parameters
79 final DetailAST paramAST =
80                 aMethodAST.findFirstToken(TokenTypes.PARAMETERS);
81             final int paramCount = paramAST.getChildCount();
82             if (paramCount != 0) {
83                 logName(aMethodAST, "paramcount.bean", new Object JavaDoc[] {"0"});
84             }
85         }
86     }
87 }
88
Popular Tags