Source Code Cross Referenced for RedundantThrowsCheck.java in  » Code-Analyzer » checkstyle » com » puppycrawl » tools » checkstyle » checks » coding » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » Code Analyzer » checkstyle » com.puppycrawl.tools.checkstyle.checks.coding 
Source Cross Referenced  Class Diagram Java Document (Java Doc) 


001:        ////////////////////////////////////////////////////////////////////////////////
002:        // checkstyle: Checks Java source code for adherence to a set of rules.
003:        // Copyright (C) 2001-2007  Oliver Burn
004:        //
005:        // This library is free software; you can redistribute it and/or
006:        // modify it under the terms of the GNU Lesser General Public
007:        // License as published by the Free Software Foundation; either
008:        // version 2.1 of the License, or (at your option) any later version.
009:        //
010:        // This library is distributed in the hope that it will be useful,
011:        // but WITHOUT ANY WARRANTY; without even the implied warranty of
012:        // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
013:        // Lesser General Public License for more details.
014:        //
015:        // You should have received a copy of the GNU Lesser General Public
016:        // License along with this library; if not, write to the Free Software
017:        // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
018:        ////////////////////////////////////////////////////////////////////////////////
019:        package com.puppycrawl.tools.checkstyle.checks.coding;
020:
021:        import com.puppycrawl.tools.checkstyle.api.DetailAST;
022:        import com.puppycrawl.tools.checkstyle.api.FullIdent;
023:        import com.puppycrawl.tools.checkstyle.api.TokenTypes;
024:        import com.puppycrawl.tools.checkstyle.checks.AbstractTypeAwareCheck;
025:        import java.util.Iterator;
026:        import java.util.LinkedList;
027:        import java.util.List;
028:
029:        /**
030:         * Checks for redundant exceptions declared in throws clause
031:         * such as duplicates, unchecked exceptions or subclasses of
032:         * another declared exception.
033:         *
034:         * <p>
035:         * An example of how to configure the check is:
036:         * </p>
037:         * <pre>
038:         * &lt;module name="RedundantThrows"&gt;
039:         *    &lt;property name=&quot;allowUnchecked&quot; value=&quot;true&quot;/&gt;
040:         *    &lt;property name=&quot;allowSubclasses&quot; value=&quot;true&quot;/&gt;
041:         * &lt;/module&gt;
042:         * </pre>
043:         * @author o_sukhodolsky
044:         */
045:        public class RedundantThrowsCheck extends AbstractTypeAwareCheck {
046:            /**
047:             * whether unchecked exceptions in throws
048:             * are allowed or not
049:             */
050:            private boolean mAllowUnchecked;
051:
052:            /**
053:             * whether subclass of another declared
054:             * exception is allowed in throws clause
055:             */
056:            private boolean mAllowSubclasses;
057:
058:            /**
059:             * Getter for allowUnchecked property.
060:             * @param aAllowUnchecked whether unchecked excpetions in throws
061:             *                         are allowed or not
062:             */
063:            public void setAllowUnchecked(boolean aAllowUnchecked) {
064:                mAllowUnchecked = aAllowUnchecked;
065:            }
066:
067:            /**
068:             * Getter for allowSubclasses property.
069:             * @param aAllowSubclasses whether subclass of another declared
070:             *                         exception is allowed in throws clause
071:             */
072:            public void setAllowSubclasses(boolean aAllowSubclasses) {
073:                mAllowSubclasses = aAllowSubclasses;
074:            }
075:
076:            /** {@inheritDoc} */
077:            public int[] getDefaultTokens() {
078:                return new int[] { TokenTypes.PACKAGE_DEF, TokenTypes.IMPORT,
079:                        TokenTypes.CLASS_DEF, TokenTypes.ENUM_DEF,
080:                        TokenTypes.METHOD_DEF, TokenTypes.CTOR_DEF, };
081:            }
082:
083:            /**
084:             * Checks exceptions declared in throws for a method or constructor.
085:             * @param aAST the tree node for the method or constructor.
086:             */
087:            protected final void processAST(DetailAST aAST) {
088:                final List knownExcs = new LinkedList();
089:                final DetailAST throwsAST = aAST
090:                        .findFirstToken(TokenTypes.LITERAL_THROWS);
091:                if (throwsAST != null) {
092:                    DetailAST child = (DetailAST) throwsAST.getFirstChild();
093:                    while (child != null) {
094:                        if ((child.getType() == TokenTypes.IDENT)
095:                                || (child.getType() == TokenTypes.DOT)) {
096:                            final FullIdent fi = FullIdent
097:                                    .createFullIdent(child);
098:                            checkException(fi, knownExcs);
099:                        }
100:                        child = (DetailAST) child.getNextSibling();
101:                    }
102:                }
103:            }
104:
105:            /**
106:             * Logs error if unable to load class information.
107:             * @param aIdent class name for which we can no load class.
108:             */
109:            protected final void logLoadError(Token aIdent) {
110:                logLoadErrorImpl(aIdent.getLineNo(), aIdent.getColumnNo(),
111:                        "redundant.throws.classInfo", new Object[] { aIdent
112:                                .getText() });
113:            }
114:
115:            /**
116:             * Checks if an exception is already know (list of known
117:             * exceptions contains it or its superclass) and it's not
118:             * a superclass for some known exception and it's not
119:             * an unchecked exception.
120:             * If it's unknown then it will be added to ist of known exception.
121:             * All subclasses of this exception will be deleted from known
122:             * and the exception  will be added instead.
123:             *
124:             * @param aExc <code>FullIdent</code> of exception to check
125:             * @param aKnownExcs list of already known exception
126:             */
127:            private void checkException(FullIdent aExc, List aKnownExcs) {
128:                // Let's try to load class.
129:                final ClassInfo newClassInfo = createClassInfo(new Token(aExc),
130:                        getCurrentClassName());
131:
132:                if (!mAllowUnchecked) {
133:                    if (isUnchecked(newClassInfo.getClazz())) {
134:                        log(aExc.getLineNo(), aExc.getColumnNo(),
135:                                "redundant.throws.unchecked", aExc.getText());
136:                    }
137:                }
138:
139:                boolean shouldAdd = true;
140:                for (final Iterator known = aKnownExcs.iterator(); known
141:                        .hasNext();) {
142:                    final ClassInfo ci = (ClassInfo) known.next();
143:                    final Token fi = ci.getName();
144:
145:                    if (ci.getClazz() == newClassInfo.getClazz()) {
146:                        shouldAdd = false;
147:                        log(aExc.getLineNo(), aExc.getColumnNo(),
148:                                "redundant.throws.duplicate", aExc.getText());
149:                    } else if (!mAllowSubclasses) {
150:                        if (isSubclass(ci.getClazz(), newClassInfo.getClazz())) {
151:                            known.remove();
152:                            log(fi.getLineNo(), fi.getColumnNo(),
153:                                    "redundant.throws.subclass", fi.getText(),
154:                                    aExc.getText());
155:                        } else if (isSubclass(newClassInfo.getClazz(), ci
156:                                .getClazz())) {
157:                            shouldAdd = false;
158:                            log(aExc.getLineNo(), aExc.getColumnNo(),
159:                                    "redundant.throws.subclass",
160:                                    aExc.getText(), fi.getText());
161:                        }
162:                    }
163:                }
164:
165:                if (shouldAdd) {
166:                    aKnownExcs.add(newClassInfo);
167:                }
168:            }
169:        }
www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.