X-Git-Url: https://git.pterodactylus.net/?a=blobdiff_plain;f=src%2Fde%2Ftodesbaum%2Fjsite%2Fapplication%2FInsertListener.java;h=40cdaf17075a2e7dbcecfe3ec9884392c44446d2;hb=f7816ebbadbf7831b48f03318e2a5866a3932c71;hp=7cc7d8d2a47431c9153d9dbfe186927a91c95e82;hpb=250630a5fb1ff745f05788210a6efd976533fb55;p=jSite.git
diff --git a/src/de/todesbaum/jsite/application/InsertListener.java b/src/de/todesbaum/jsite/application/InsertListener.java
index 7cc7d8d..40cdaf1 100644
--- a/src/de/todesbaum/jsite/application/InsertListener.java
+++ b/src/de/todesbaum/jsite/application/InsertListener.java
@@ -22,19 +22,92 @@ package de.todesbaum.jsite.application;
import java.util.EventListener;
/**
+ * Interface for objects that want to be notified abount insert events.
+ *
* @author David âBombeâ Roden <bombe@freenetproject.org>
*/
public interface InsertListener extends EventListener {
+ /**
+ * Enumeration for the different error situations.
+ *
+ * @author David âBombeâ Roden <bombe@freenetproject.org>
+ */
public static enum ErrorType {
- KEY_COLLISION, ROUTE_NOT_FOUND, DATA_NOT_FOUND, FCP_ERROR, IO_ERROR
+
+ /** The key does already exist. */
+ KEY_COLLISION,
+
+ /** The route to the key was not found. */
+ ROUTE_NOT_FOUND,
+
+ /** The data was not found. */
+ DATA_NOT_FOUND,
+
+ /** Error in the FCP communication. */
+ FCP_ERROR,
+
+ /** General error in the communication. */
+ IO_ERROR
}
+ /**
+ * Notifies a listener that an insert has started.
+ *
+ * @param project
+ * The project that is now being inserted
+ */
public void projectInsertStarted(Project project);
+
+ /**
+ * Notifies a listener that the upload of a project has finished and the
+ * inserting will start now.
+ *
+ * @param project
+ * The project that has been uploaded
+ */
+ public void projectUploadFinished(Project project);
+
+ /**
+ * Notifies a listener that a project insert has generated a URI.
+ *
+ * @param project
+ * The project being inserted
+ * @param uri
+ * The generated URI
+ */
public void projectURIGenerated(Project project, String uri);
+ /**
+ * Notifies a listener that an insert has made some progress.
+ *
+ * @param project
+ * The project being inserted
+ * @param succeeded
+ * The number of succeeded blocks
+ * @param failed
+ * The number of failed blocks
+ * @param fatal
+ * The number of fatally failed blocks
+ * @param total
+ * The total number of blocks
+ * @param finalized
+ * true
if the total number of blocks has been
+ * finalized, false
otherwise
+ */
public void projectInsertProgress(Project project, int succeeded, int failed, int fatal, int total, boolean finalized);
+ /**
+ * Notifies a listener that a project insert has finished.
+ *
+ * @param project
+ * The project being inserted
+ * @param success
+ * true
if the insert succeeded, false
+ * otherwise
+ * @param cause
+ * The cause of a failure, if any (may be null
)
+ */
public void projectInsertFinished(Project project, boolean success, Throwable cause);
}