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 edu.rice.cs.drjava.model.GlobalModel;
041: import edu.rice.cs.drjava.model.OpenDefinitionsDocument;
042: import edu.rice.cs.drjava.model.FileSaveSelector;
043: import edu.rice.cs.drjava.model.compiler.CompilerErrorModel;
044: import edu.rice.cs.drjava.model.compiler.CompilerError;
045: import edu.rice.cs.util.DirectorySelector;
046:
047: /**
048: * Javadoc model to use when javadoc is unavailable.
049: * @version $Id: JavadocModel.java 3901 2006-06-30 05:28:11Z rcartwright $
050: */
051: public class NoJavadocAvailable implements JavadocModel {
052:
053: private final JavadocEventNotifier _notifier = new JavadocEventNotifier();
054: private final CompilerErrorModel _javadocErrorModel;
055:
056: public NoJavadocAvailable(GlobalModel model) {
057: CompilerError e = new CompilerError(
058: "The javadoc feature is not available.", false);
059: _javadocErrorModel = new CompilerErrorModel(
060: new CompilerError[] { e }, model);
061: }
062:
063: public boolean isAvailable() {
064: return false;
065: }
066:
067: /** Add a JavadocListener to the model.
068: * @param listener a listener that reacts to Javadoc events
069: */
070: public void addListener(JavadocListener listener) {
071: _notifier.addListener(listener);
072: }
073:
074: /** Remove a JavadocListener from the model. If the listener is not currently
075: * listening to this model, this method has no effect.
076: * @param listener a listener that reacts to Javadoc events
077: */
078: public void removeListener(JavadocListener listener) {
079: _notifier.removeListener(listener);
080: }
081:
082: /** Removes all JavadocListeners from this model. */
083: public void removeAllListeners() {
084: _notifier.removeAllListeners();
085: }
086:
087: /** Accessor for the Javadoc error model. */
088: public CompilerErrorModel getJavadocErrorModel() {
089: return _javadocErrorModel;
090: }
091:
092: /** Clears all current Javadoc errors. */
093: public void resetJavadocErrors() { /* ignore */
094: }
095:
096: /**
097: * Suggests a default location for generating Javadoc, based on the given
098: * document's source root. (Appends JavadocModel.SUGGESTED_DIR_NAME to
099: * the sourceroot.)
100: * @param doc Document with the source root to use as the default.
101: * @return Suggested destination directory, or null if none could be
102: * determined.
103: */
104: public File suggestJavadocDestination(OpenDefinitionsDocument doc) {
105: return null;
106: }
107:
108: /**
109: * Javadocs all open documents, after ensuring that all are saved.
110: * The user provides a destination, and the gm provides the package info.
111: *
112: * @param select a command object for selecting a directory and warning a user
113: * about bad input
114: * @param saver a command object for saving a document (if it moved/changed)
115: *
116: * @throws IOException if there is a problem manipulating files
117: */
118: public void javadocAll(DirectorySelector select,
119: FileSaveSelector saver) {
120: _notifier.javadocStarted();
121: _notifier.javadocEnded(false, null, true);
122: }
123:
124: /**
125: * Generates Javadoc for the given document only, after ensuring it is saved.
126: * Saves the output to a temporary directory, which is provided in the
127: * javadocEnded event on the provided listener.
128: *
129: * @param doc Document to generate Javadoc for
130: * @param saver a command object for saving the document (if it moved/changed)
131: *
132: * @throws IOException if there is a problem manipulating files
133: */
134: public void javadocDocument(OpenDefinitionsDocument doc,
135: FileSaveSelector saver) {
136: _notifier.javadocStarted();
137: _notifier.javadocEnded(false, null, true);
138: }
139:
140: }
|