KickJava   Java API By Example, From Geeks To Geeks.

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


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.Check;
22 import com.puppycrawl.tools.checkstyle.api.DetailAST;
23 import com.puppycrawl.tools.checkstyle.api.TokenTypes;
24
25 /**
26  * Checks that 'this' is not returned by a bean method.
27  * Instead, you must use the result of the getEJBObject()
28  * available in SessionContext or EntityContext.
29  * http://www.javaworld.com/javaworld/jw-08-2000/jw-0825-ejbrestrict.html
30  * @author Rick Giles
31  */
32 public class ThisReturnCheck
33     extends Check
34 {
35     /**
36      * {@inheritDoc}
37      */
38     public int[] getDefaultTokens()
39     {
40         return new int[] {TokenTypes.LITERAL_THIS};
41     }
42
43     /**
44      * {@inheritDoc}
45      */
46     public int[] getRequiredTokens()
47     {
48         return getDefaultTokens();
49     }
50
51     /**
52      * {@inheritDoc}
53      */
54     public void visitToken(DetailAST aAST)
55     {
56         if (Utils.isInEJB(aAST)) {
57             DetailAST parent = aAST.getParent();
58
59             // skip parentheses
60 while ((parent != null)
61                 && (parent.getType() == TokenTypes.LPAREN))
62             {
63                 parent = parent.getParent();
64             }
65
66             if ((parent != null)
67                 && (parent.getType() == TokenTypes.EXPR))
68             {
69                 parent = parent.getParent();
70                 if ((parent != null)
71                     && (parent.getType() == TokenTypes.LITERAL_RETURN))
72                 {
73                     log(
74                         aAST.getLineNo(),
75                         aAST.getColumnNo(),
76                         "thisreturn.bean");
77                 }
78             }
79         }
80     }
81 }
82
Popular Tags