X-Git-Url: https://git.pterodactylus.net/?a=blobdiff_plain;f=src%2Fde%2Ftodesbaum%2Fjsite%2Fapplication%2FInsertListener.java;h=9b6b3321c3cfb0bbe24278a80232dbbdfc29e455;hb=e47e15fdbb7515f5a3757c3f5df8c1d0950aee8e;hp=e3328cce3ab179fa89d3875b48496eafb3215ec0;hpb=e4f461213da0e30faf9e9eb2e97626abff320618;p=jSite.git

diff --git a/src/de/todesbaum/jsite/application/InsertListener.java b/src/de/todesbaum/jsite/application/InsertListener.java
index e3328cc..9b6b332 100644
--- a/src/de/todesbaum/jsite/application/InsertListener.java
+++ b/src/de/todesbaum/jsite/application/InsertListener.java
@@ -1,6 +1,5 @@
 /*
- * jSite - a tool for uploading websites into Freenet
- * Copyright (C) 2006 David Roden
+ * jSite - InsertListener.java - Copyright © 2006–2012 David Roden
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -22,20 +21,92 @@ package de.todesbaum.jsite.application;
 import java.util.EventListener;
 
 /**
- * @author David Roden <droden@gmail.com>
- * @version $Id$
+ * 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
+	 *            <code>true</code> if the total number of blocks has been
+	 *            finalized, <code>false</code> 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
+	 *            <code>true</code> if the insert succeeded, <code>false</code>
+	 *            otherwise
+	 * @param cause
+	 *            The cause of a failure, if any (may be <code>null</code>)
+	 */
 	public void projectInsertFinished(Project project, boolean success, Throwable cause);
 
 }