edu.rice.cs.drjava.model.javadoc
Interface JavadocListener

All Known Subinterfaces:

GlobalModelListener

All Known Implementing Classes:

DebugTestCase.InterpretListener, DefinitionsPaneMemoryLeakTest.DocChangeListener, DummyGlobalModelListener, GlobalEventNotifier, GlobalModelIOTest.TestFileIOListener, GlobalModelIOTest.TestIOListener, GlobalModelJUnitTest.JUnitCompileBeforeTestListener, GlobalModelTestCase.CompileShouldFailListener, GlobalModelTestCase.CompileShouldSucceedListener, GlobalModelTestCase.InteractionListener, GlobalModelTestCase.JUnitNonTestListener, GlobalModelTestCase.JUnitTestListener, GlobalModelTestCase.TestListener, JavadocEventNotifier, MainFrame.ModelListener, MainFrameTest.SingleDisplayModelCompileListener, MainFrameTest.SingleDisplayModelFileClosedListener, MainFrameTest.SingleDisplayModelFileOpenedListener, SingleDisplayModelTest.SDTestListener

public interface JavadocListener

An interface for responding to events generated by the JavadocModel.

Version:

$Id: JavadocListener.java 5189 2010-03-09 01:40:37Z mgricken $

Method Summary

void	compileBeforeJavadoc(CompilerListener afterCompile) Called before attempting Javadoc, to give the user a chance to compile.
void	javadocEnded(boolean success, java.io.File destDir, boolean allDocs) Called after Javadoc is finished.
void	javadocStarted() Called after Javadoc is started by the GlobalModel.
void	saveBeforeJavadoc() Called to demand that all files be saved before generating Javadoc.

Method Detail

saveBeforeJavadoc

void saveBeforeJavadoc()

Called to demand that all files be saved before generating Javadoc. It is up to the caller of this method to check if the documents have been saved, using IGetDocuments.hasModifiedDocuments(). Do not continue with Javadoc if the user doesn't save!

compileBeforeJavadoc

void compileBeforeJavadoc(CompilerListener afterCompile)

Called before attempting Javadoc, to give the user a chance to compile. Do not continue with Javadoc if the user doesn't comoile!

javadocStarted

void javadocStarted()

Called after Javadoc is started by the GlobalModel.

javadocEnded

void javadocEnded(boolean success,
                  java.io.File destDir,
                  boolean allDocs)

Called after Javadoc is finished.

Parameters:

success - whether the Javadoc operation generated proper output

destDir - if (success == true) the location where the output was generated, otherwise undefined (null?)

allDocs - Whether we are running over all open documents