Source Code Cross Referenced for AbstractBuilder.java in  » 6.0-JDK-Modules-com.sun » tools » com » sun » tools » doclets » internal » toolkit » builders » 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 » 6.0 JDK Modules com.sun » tools » com.sun.tools.doclets.internal.toolkit.builders 
Source Cross Referenced  Class Diagram Java Document (Java Doc) 


001:        /*
002:         * Copyright 2003 Sun Microsystems, Inc.  All Rights Reserved.
003:         * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
004:         *
005:         * This code is free software; you can redistribute it and/or modify it
006:         * under the terms of the GNU General Public License version 2 only, as
007:         * published by the Free Software Foundation.  Sun designates this
008:         * particular file as subject to the "Classpath" exception as provided
009:         * by Sun in the LICENSE file that accompanied this code.
010:         *
011:         * This code is distributed in the hope that it will be useful, but WITHOUT
012:         * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
013:         * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
014:         * version 2 for more details (a copy is included in the LICENSE file that
015:         * accompanied this code).
016:         *
017:         * You should have received a copy of the GNU General Public License version
018:         * 2 along with this work; if not, write to the Free Software Foundation,
019:         * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
020:         *
021:         * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
022:         * CA 95054 USA or visit www.sun.com if you need additional information or
023:         * have any questions.
024:         */
025:
026:        package com.sun.tools.doclets.internal.toolkit.builders;
027:
028:        import com.sun.tools.doclets.internal.toolkit.*;
029:        import com.sun.tools.doclets.internal.toolkit.util.*;
030:        import java.io.*;
031:        import java.lang.reflect.*;
032:        import java.util.*;
033:
034:        /**
035:         * The superclass for all builders.  A builder is a class that provides
036:         * the structure and content of API documentation.  A builder is completely
037:         * doclet independent which means that any doclet can use builders to
038:         * construct documentation, as long as it impelements the appropriate
039:         * writer interfaces.  For example, if a doclet wanted to use 
040:         * {@link ConstantsSummaryBuilder} to build a constant summary, all it has to
041:         * do is implement the ConstantsSummaryWriter interface and pass it to the 
042:         * builder using a WriterFactory.
043:         *
044:         * This code is not part of an API.
045:         * It is implementation that is subject to change.
046:         * Do not use it as an API
047:         * 
048:         * @author Jamie Ho
049:         * @since 1.5
050:         */
051:
052:        public abstract class AbstractBuilder {
053:
054:            /**
055:             * The configuration used in this run of the doclet.
056:             */
057:            protected Configuration configuration;
058:
059:            /**
060:             * Keep track of which packages we have seen for
061:             * efficiency purposes.  We don't want to copy the
062:             * doc files multiple times for a single package.
063:             */
064:            protected static Set containingPackagesSeen;
065:
066:            /**
067:             * True if we want to print debug output.
068:             */
069:            protected static final boolean DEBUG = false;
070:
071:            /**
072:             * Construct a Builder.
073:             * @param configuration the configuration used in this run
074:             *        of the doclet.
075:             */
076:            public AbstractBuilder(Configuration configuration) {
077:                this .configuration = configuration;
078:            }
079:
080:            /**
081:             * Return the name of this builder.
082:             *
083:             * @return the name of the builder.
084:             */
085:            public abstract String getName();
086:
087:            /**
088:             * Build the documentation.
089:             *
090:             * @throws IOException there was a problem writing the output.
091:             */
092:            public abstract void build() throws IOException;
093:
094:            /**
095:             * Build the documentation, as specified by the given XML elements.
096:             *
097:             * @param elements the XML elements that specify which components to 
098:             *                 document.
099:             */
100:            protected void build(List elements) {
101:                for (int i = 0; i < elements.size(); i++) {
102:                    Object element = elements.get(i);
103:                    String component = (String) ((element instanceof  String) ? element
104:                            : ((List) element).get(0));
105:                    try {
106:                        invokeMethod("build" + component,
107:                                element instanceof  String ? new Class[] {}
108:                                        : new Class[] { List.class },
109:                                element instanceof  String ? new Object[] {}
110:                                        : new Object[] { ((List) element)
111:                                                .subList(1, ((List) element)
112:                                                        .size()) });
113:                    } catch (NoSuchMethodException e) {
114:                        e.printStackTrace();
115:                        configuration.root.printError("Unknown element: "
116:                                + component);
117:                        throw new DocletAbortException();
118:                    } catch (InvocationTargetException e) {
119:                        e.getCause().printStackTrace();
120:                    } catch (Exception e) {
121:                        e.printStackTrace();
122:                        configuration.root.printError("Exception "
123:                                + e.getClass().getName()
124:                                + " thrown while processing element: "
125:                                + component);
126:                        throw new DocletAbortException();
127:                    }
128:                }
129:            }
130:
131:            /**
132:             * Given the name and parameters, invoke the method in the builder.  This 
133:             * method is required to invoke the appropriate build method as instructed
134:             * by the builder XML file.
135:             *
136:             * @param methodName   the name of the method that we would like to invoke.
137:             * @param paramClasses the types for each parameter.
138:             * @param params       the parameters of the method.
139:             */
140:            protected abstract void invokeMethod(String methodName,
141:                    Class[] paramClasses, Object[] params) throws Exception;
142:        }
w___w___w___.___j___a_v__a2_s___.___c___o__m_ | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.