Source Code Cross Referenced for ForceJavadocComments.java in  » UML » jrefactory » org » acm » seguin » pretty » 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 » UML » jrefactory » org.acm.seguin.pretty 
Source Cross Referenced  Class Diagram Java Document (Java Doc) 


01:        /*
02:         *  Author:  Chris Seguin
03:         *
04:         *  This software has been developed under the copyleft
05:         *  rules of the GNU General Public License.  Please
06:         *  consult the GNU General Public License for more
07:         *  details about use and distribution of this software.
08:         */
09:        package org.acm.seguin.pretty;
10:
11:        import net.sourceforge.jrefactory.ast.ModifierHolder;
12:        import org.acm.seguin.util.FileSettings;
13:        import org.acm.seguin.util.SettingNotFoundException;
14:
15:        /**
16:         *  Forces javadoc comments only for a certain level of source code. The level 
17:         *  is based on the permissions associated with the file. 
18:         *
19:         *@author     Chris Seguin 
20:         *@created    December 20, 1999 
21:         */
22:        public class ForceJavadocComments {
23:            /**
24:             *  Determines if the java doc comment is required for the particular method 
25:             *  or field 
26:             *
27:             *@param  type  the type (method or field) 
28:             *@param  mods  the modifiers associated with this object 
29:             *@return       true if they are required 
30:             */
31:            public boolean isJavaDocRequired(String type, ModifierHolder mods) {
32:                //  Get the resource bundle
33:                FileSettings bundle = FileSettings.getRefactoryPrettySettings();
34:
35:                //  Determine the minimum acceptable level
36:                String minimumLevel = "none";
37:                try {
38:                    minimumLevel = bundle.getString(type + ".minimum");
39:                } catch (SettingNotFoundException snfe) {
40:                    //  Use default value
41:                }
42:
43:                //	Check the level
44:                return isAll(minimumLevel) || isPackage(minimumLevel, mods)
45:                        || isProtected(minimumLevel, mods)
46:                        || isPublic(minimumLevel, mods);
47:            }
48:
49:            /**
50:             *  Gets the All attribute of the ForceJavadocComments object 
51:             *
52:             *@param  level  Description of Parameter 
53:             *@return        The All value 
54:             */
55:            private boolean isAll(String level) {
56:                return level.equalsIgnoreCase("all")
57:                        || level.equalsIgnoreCase("private");
58:            }
59:
60:            /**
61:             *  Gets the Package attribute of the ForceJavadocComments object 
62:             *
63:             *@param  level  Description of Parameter 
64:             *@param  mods   Description of Parameter 
65:             *@return        The Package value 
66:             */
67:            private boolean isPackage(String level, ModifierHolder mods) {
68:                return (level.equalsIgnoreCase("package") || level
69:                        .equalsIgnoreCase("default"))
70:                        && !mods.isPrivate();
71:            }
72:
73:            /**
74:             *  Gets the Protected attribute of the ForceJavadocComments object 
75:             *
76:             *@param  level  Description of Parameter 
77:             *@param  mods   Description of Parameter 
78:             *@return        The Protected value 
79:             */
80:            private boolean isProtected(String level, ModifierHolder mods) {
81:                return level.equalsIgnoreCase("protected")
82:                        && (mods.isProtected() || mods.isPublic());
83:            }
84:
85:            /**
86:             *  Gets the Public attribute of the ForceJavadocComments object 
87:             *
88:             *@param  level  Description of Parameter 
89:             *@param  mods   Description of Parameter 
90:             *@return        The Public value 
91:             */
92:            private boolean isPublic(String level, ModifierHolder mods) {
93:                return level.equalsIgnoreCase("public") && mods.isPublic();
94:            }
95:
96:        }
www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.