Source Code Cross Referenced for JavadocModel.java in  » IDE » DrJava » edu » rice » cs » drjava » model » javadoc » 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 » IDE » DrJava » edu.rice.cs.drjava.model.javadoc 
Source Cross Referenced  Class Diagram Java Document (Java Doc) 


001:        /*BEGIN_COPYRIGHT_BLOCK
002:         *
003:         * Copyright (c) 2001-2007, JavaPLT group at Rice University (javaplt@rice.edu)
004:         * All rights reserved.
005:         * 
006:         * Redistribution and use in source and binary forms, with or without
007:         * modification, are permitted provided that the following conditions are met:
008:         *    * Redistributions of source code must retain the above copyright
009:         *      notice, this list of conditions and the following disclaimer.
010:         *    * Redistributions in binary form must reproduce the above copyright
011:         *      notice, this list of conditions and the following disclaimer in the
012:         *      documentation and/or other materials provided with the distribution.
013:         *    * Neither the names of DrJava, the JavaPLT group, Rice University, nor the
014:         *      names of its contributors may be used to endorse or promote products
015:         *      derived from this software without specific prior written permission.
016:         * 
017:         * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
018:         * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
019:         * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
020:         * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
021:         * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
022:         * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
023:         * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
024:         * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
025:         * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
026:         * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
027:         * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
028:         *
029:         * This software is Open Source Initiative approved Open Source Software.
030:         * Open Source Initative Approved is a trademark of the Open Source Initiative.
031:         * 
032:         * This file is part of DrJava.  Download the current version of this project
033:         * from http://www.drjava.org/ or http://sourceforge.net/projects/drjava/
034:         * 
035:         * END_COPYRIGHT_BLOCK*/
036:
037:        package edu.rice.cs.drjava.model.javadoc;
038:
039:        import java.io.File;
040:        import java.io.IOException;
041:
042:        import edu.rice.cs.drjava.model.OpenDefinitionsDocument;
043:        import edu.rice.cs.drjava.model.FileSaveSelector;
044:        import edu.rice.cs.drjava.model.compiler.CompilerErrorModel;
045:        import edu.rice.cs.util.DirectorySelector;
046:
047:        /**
048:         * Model interface for Javadoc integration features.
049:         * Note: Implementors should have a constructor taking an IGetDocuments.
050:         * @version $Id: JavadocModel.java 4255 2007-08-28 19:17:37Z mgricken $
051:         */
052:        public interface JavadocModel {
053:            /**
054:             * Name for the suggested destination directory to be placed in the
055:             * source root of one of the open documents.  (Value is "doc".)
056:             */
057:            public static final String SUGGESTED_DIR_NAME = "doc";
058:
059:            /** {@code true} iff the classes to run javadoc are available */
060:            public boolean isAvailable();
061:
062:            /**
063:             * Add a JavadocListener to the model.
064:             * @param listener a listener that reacts to Javadoc events
065:             */
066:            public void addListener(JavadocListener listener);
067:
068:            /**
069:             * Remove a JavadocListener from the model.  If the listener is not currently
070:             * listening to this model, this method has no effect.
071:             * @param listener a listener that reacts to Javadoc events
072:             */
073:            public void removeListener(JavadocListener listener);
074:
075:            /** Removes all JavadocListeners from this model. */
076:            public void removeAllListeners();
077:
078:            /** Accessor for the Javadoc error model. */
079:            public CompilerErrorModel getJavadocErrorModel();
080:
081:            /** Clears all current Javadoc errors. */
082:            public void resetJavadocErrors();
083:
084:            /**
085:             * Suggests a default location for generating Javadoc, based on the given
086:             * document's source root.  (Appends JavadocModel.SUGGESTED_DIR_NAME to
087:             * the sourceroot.)
088:             * @param doc Document with the source root to use as the default.
089:             * @return Suggested destination directory, or null if none could be
090:             * determined.
091:             */
092:            public File suggestJavadocDestination(OpenDefinitionsDocument doc);
093:
094:            /**
095:             * Javadocs all open documents, after ensuring that all are saved.
096:             * The user provides a destination, and the gm provides the package info.
097:             * 
098:             * @param select a command object for selecting a directory and warning a user
099:             *        about bad input
100:             * @param saver a command object for saving a document (if it moved/changed)
101:             * 
102:             * @throws IOException if there is a problem manipulating files
103:             */
104:            public void javadocAll(DirectorySelector select,
105:                    FileSaveSelector saver) throws IOException;
106:
107:            /**
108:             * Generates Javadoc for the given document only, after ensuring it is saved.
109:             * Saves the output to a temporary directory, which is provided in the
110:             * javadocEnded event on the provided listener.
111:             * 
112:             * @param doc Document to generate Javadoc for
113:             * @param saver a command object for saving the document (if it moved/changed)
114:             * 
115:             * @throws IOException if there is a problem manipulating files
116:             */
117:            public void javadocDocument(OpenDefinitionsDocument doc,
118:                    FileSaveSelector saver) throws IOException;
119:        }
www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.