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: }
|