SessionBeanMethodChecker


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 session bean.
26   * Reference: Enterprise JavaBeansTM Specification,Version 2.0, section 7.10.2.
27   * @author Rick Giles
28   */
29  public class SessionBeanMethodChecker
30      extends BeanMethodChecker
31  {
32      /** true if the session bean has an ejbCreate<METHOD>(...) method */
33      private boolean mHasEjbCreate;
34  
35      /**
36       * Creates a method checker for a session bean check.
37       * @param aCheck the session bean check.
38       */
39      public SessionBeanMethodChecker(SessionBeanCheck aCheck)
40      {
41          super(aCheck);
42      }
43  
44      /**
45       * {@inheritDoc}
46       */
47      public void checkMethods(DetailAST aAST)
48      {
49          mHasEjbCreate = false;
50  
51          super.checkMethods(aAST);
52  
53          // session bean must have an ejbCreate<METHOD>(...) method
54          if (!mHasEjbCreate) {
55              final DetailAST nameAST = aAST.findFirstToken(TokenTypes.IDENT);
56              final String   name = nameAST.getText();
57              final String   arg = "Session bean '" + name + "'";
58              log(
59                  aAST,
60                  "missingmethod.bean",
61                  new Object  [] {arg, "ejbCreate<METHOD>(...)"});
62          }
63      }
64  
65      /**
66       * {@inheritDoc}
67       */
68      protected void checkCreateMethod(DetailAST aMethodAST)
69      {
70          super.checkCreateMethod(aMethodAST);
71  
72          if (Utils.isPublic(aMethodAST)
73              && !Utils.isStatic(aMethodAST)
74              && !Utils.isFinal(aMethodAST)
75              && Utils.isVoid(aMethodAST))
76          {
77              mHasEjbCreate = true;
78          }
79  
80          // The return type must be void
81          if (!Utils.isVoid(aMethodAST)) {
82              log(aMethodAST, "nonvoidmethod.bean", new Object  [] {});
83          }
84      }
85  }
86
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags