Author: tobr
Date: Thu Jun 7 11:20:24 2012
New Revision: 1347573
URL: http://svn.apache.org/viewvc?rev=1347573&view=rev
Log:
added javadocs
Modified:
incubator/droids/trunk/droids-core/src/main/java/org/apache/droids/LinkTask.java
incubator/droids/trunk/droids-core/src/main/java/org/apache/droids/api/TaskExceptionHandler.java
incubator/droids/trunk/droids-core/src/main/java/org/apache/droids/api/TaskExceptionResult.java
incubator/droids/trunk/droids-core/src/main/java/org/apache/droids/api/TaskMaster.java
incubator/droids/trunk/droids-core/src/main/java/org/apache/droids/api/TaskValidator.java
incubator/droids/trunk/droids-core/src/main/java/org/apache/droids/api/WorkMonitor.java
incubator/droids/trunk/droids-core/src/main/java/org/apache/droids/api/Worker.java
Modified:
incubator/droids/trunk/droids-core/src/main/java/org/apache/droids/LinkTask.java
URL:
http://svn.apache.org/viewvc/incubator/droids/trunk/droids-core/src/main/java/org/apache/droids/LinkTask.java?rev=1347573&r1=1347572&r2=1347573&view=diff
==============================================================================
---
incubator/droids/trunk/droids-core/src/main/java/org/apache/droids/LinkTask.java
(original)
+++
incubator/droids/trunk/droids-core/src/main/java/org/apache/droids/LinkTask.java
Thu Jun 7 11:20:24 2012
@@ -23,6 +23,12 @@ import java.io.Serializable;
import org.apache.droids.api.Link;
+/**
+ *
+ * Basic implementation for @Link.
+ * LinkTasks are working instructions for URI based droids.
+ *
+ */
public class LinkTask implements Link, Serializable {
private static final long serialVersionUID = -44808094386453088L;
@@ -37,6 +43,13 @@ public class LinkTask implements Link, S
private int weight;
private boolean aborted = false;
+ /**
+ * Creates a new LinkTask.
+ *
+ * @param from
+ * @param uri
+ * @param depth
+ */
public LinkTask(Link from, URI uri, int depth) {
this.from = from;
this.uri = uri;
@@ -44,6 +57,14 @@ public class LinkTask implements Link, S
this.started = new Date();
}
+ /**
+ * Creates a new LinkTask.
+ *
+ * @param from
+ * @param uri
+ * @param depth
+ * @param weight
+ */
public LinkTask(Link from, URI uri, int depth, int weight) {
this.from = from;
this.uri = uri;
@@ -52,6 +73,14 @@ public class LinkTask implements Link, S
this.weight = weight;
}
+ /**
+ * Creates a new LinkTask
+ *
+ * @param from
+ * @param uri
+ * @param depth
+ * @param anchorText
+ */
public LinkTask(Link from, URI uri, int depth, String anchorText) {
this(from, uri, depth);
this.anchorText = anchorText;
@@ -67,6 +96,11 @@ public class LinkTask implements Link, S
return started;
}
+ /**
+ * Set the Date the task started.
+ *
+ * @param started
+ */
public void setTaskDate(Date started) {
this.started = started;
}
@@ -91,10 +125,20 @@ public class LinkTask implements Link, S
return lastModifedDate;
}
+ /**
+ * Set the Date the Task object was last modified.
+ *
+ * @param lastModifedDate
+ */
public void setLastModifedDate(Date lastModifedDate) {
this.lastModifedDate = lastModifedDate;
}
+ /**
+ * Set Outgoing links.
+ *
+ * @param linksTo
+ */
public void setLinksTo(Collection<URI> linksTo) {
this.linksTo = linksTo;
}
@@ -109,14 +153,29 @@ public class LinkTask implements Link, S
return anchorText;
}
+ /**
+ * Set the anchor text for this link.
+ *
+ * @param anchorText
+ */
public void setAnchorText(String anchorText) {
this.anchorText = anchorText;
}
+ /**
+ * Get the weight of the link
+ *
+ * @return the links weight
+ */
public int getWeight() {
return weight;
}
+ /**
+ * Set the weight of the link.
+ *
+ * @param weight
+ */
public void setWeight(int weight) {
this.weight = weight;
}
Modified:
incubator/droids/trunk/droids-core/src/main/java/org/apache/droids/api/TaskExceptionHandler.java
URL:
http://svn.apache.org/viewvc/incubator/droids/trunk/droids-core/src/main/java/org/apache/droids/api/TaskExceptionHandler.java?rev=1347573&r1=1347572&r2=1347573&view=diff
==============================================================================
---
incubator/droids/trunk/droids-core/src/main/java/org/apache/droids/api/TaskExceptionHandler.java
(original)
+++
incubator/droids/trunk/droids-core/src/main/java/org/apache/droids/api/TaskExceptionHandler.java
Thu Jun 7 11:20:24 2012
@@ -16,9 +16,20 @@
*/
package org.apache.droids.api;
+/**
+ *
+ * Handler for task exceptions.
+ *
+ */
public interface TaskExceptionHandler
{
+ /**
+ * Handle an exception.
+ *
+ * @param ex
+ * @return the kind of exception
+ */
TaskExceptionResult handleException(Exception ex);
}
Modified:
incubator/droids/trunk/droids-core/src/main/java/org/apache/droids/api/TaskExceptionResult.java
URL:
http://svn.apache.org/viewvc/incubator/droids/trunk/droids-core/src/main/java/org/apache/droids/api/TaskExceptionResult.java?rev=1347573&r1=1347572&r2=1347573&view=diff
==============================================================================
---
incubator/droids/trunk/droids-core/src/main/java/org/apache/droids/api/TaskExceptionResult.java
(original)
+++
incubator/droids/trunk/droids-core/src/main/java/org/apache/droids/api/TaskExceptionResult.java
Thu Jun 7 11:20:24 2012
@@ -16,6 +16,11 @@
*/
package org.apache.droids.api;
+/**
+ *
+ * Set of constants describing the kind of an exception.
+ *
+ */
public enum TaskExceptionResult
{
Modified:
incubator/droids/trunk/droids-core/src/main/java/org/apache/droids/api/TaskMaster.java
URL:
http://svn.apache.org/viewvc/incubator/droids/trunk/droids-core/src/main/java/org/apache/droids/api/TaskMaster.java?rev=1347573&r1=1347572&r2=1347573&view=diff
==============================================================================
---
incubator/droids/trunk/droids-core/src/main/java/org/apache/droids/api/TaskMaster.java
(original)
+++
incubator/droids/trunk/droids-core/src/main/java/org/apache/droids/api/TaskMaster.java
Thu Jun 7 11:20:24 2012
@@ -21,11 +21,15 @@ import java.util.Queue;
import java.util.concurrent.TimeUnit;
/**
- * Responsible for running all the tasks
+ *
+ * A TaskMaster is responsible for running all the tasks.
+ *
*/
public interface TaskMaster<T extends Task>
{
-
+ /**
+ * Possible execution states for the TaskMaster.
+ */
public enum ExecutionState
{
INITIALIZED, RUNNING, STOPPED, COMPLETED
@@ -48,8 +52,18 @@ public interface TaskMaster<T extends Ta
*/
boolean awaitTermination(long timeout, TimeUnit unit) throws
InterruptedException;
+ /**
+ * Set the exception handler
+ *
+ * @param taskExceptionHandler
+ */
void setExceptionHandler(TaskExceptionHandler taskExceptionHandler);
+ /**
+ * Set a delay timer.
+ *
+ * @param simpleDelayTimer
+ */
void setDelayTimer(DelayTimer simpleDelayTimer);
/**
@@ -59,11 +73,31 @@ public interface TaskMaster<T extends Ta
*/
ExecutionState getExecutionState();
+ /**
+ * Get the Date the TaskMaster started to work.
+ *
+ * @return the start date
+ */
Date getStartTime();
+ /**
+ * Get the Date the TaskMaster finished.
+ *
+ * @return the work-finished date
+ */
Date getFinishedWorking();
+ /**
+ * Get the number of completed tasks.
+ *
+ * @return number of completed tasks
+ */
long getCompletedTasks();
+ /**
+ * Get the last completed task.
+ *
+ * @return the last task
+ */
T getLastCompletedTask();
}
Modified:
incubator/droids/trunk/droids-core/src/main/java/org/apache/droids/api/TaskValidator.java
URL:
http://svn.apache.org/viewvc/incubator/droids/trunk/droids-core/src/main/java/org/apache/droids/api/TaskValidator.java?rev=1347573&r1=1347572&r2=1347573&view=diff
==============================================================================
---
incubator/droids/trunk/droids-core/src/main/java/org/apache/droids/api/TaskValidator.java
(original)
+++
incubator/droids/trunk/droids-core/src/main/java/org/apache/droids/api/TaskValidator.java
Thu Jun 7 11:20:24 2012
@@ -18,7 +18,9 @@ package org.apache.droids.api;
/**
*
- * @since 1.0
+ * Interface for the validation of tasks.
+ *
+ * <p>Implementations of TaskValidator make sure that only valid tasks are
added to the workers queue.</p>
*/
public interface TaskValidator<T extends Task> {
/**
Modified:
incubator/droids/trunk/droids-core/src/main/java/org/apache/droids/api/WorkMonitor.java
URL:
http://svn.apache.org/viewvc/incubator/droids/trunk/droids-core/src/main/java/org/apache/droids/api/WorkMonitor.java?rev=1347573&r1=1347572&r2=1347573&view=diff
==============================================================================
---
incubator/droids/trunk/droids-core/src/main/java/org/apache/droids/api/WorkMonitor.java
(original)
+++
incubator/droids/trunk/droids-core/src/main/java/org/apache/droids/api/WorkMonitor.java
Thu Jun 7 11:20:24 2012
@@ -16,8 +16,27 @@
*/
package org.apache.droids.api;
-
+/**
+ * Monitor the execution of Tasks.
+ *
+ * @param <T>
+ */
public interface WorkMonitor<T extends Task> {
+
+ /**
+ * Monitor the task before the execution.
+ *
+ * @param task
+ * @param worker
+ */
void beforeExecute( final T task, final Worker<T> worker );
+
+ /**
+ * Monitor the task after the execution.
+ *
+ * @param task
+ * @param worker
+ * @param ex
+ */
void afterExecute( final T task, final Worker<T> worker, Exception ex );
}
Modified:
incubator/droids/trunk/droids-core/src/main/java/org/apache/droids/api/Worker.java
URL:
http://svn.apache.org/viewvc/incubator/droids/trunk/droids-core/src/main/java/org/apache/droids/api/Worker.java?rev=1347573&r1=1347572&r2=1347573&view=diff
==============================================================================
---
incubator/droids/trunk/droids-core/src/main/java/org/apache/droids/api/Worker.java
(original)
+++
incubator/droids/trunk/droids-core/src/main/java/org/apache/droids/api/Worker.java
Thu Jun 7 11:20:24 2012
@@ -32,6 +32,13 @@ import org.apache.droids.exception.Droid
*/
public interface Worker<T extends Task> {
+ /**
+ * Executes a task.
+ *
+ * @param task
+ * @throws DroidsException
+ * @throws IOException
+ */
void execute( final T task ) throws DroidsException, IOException;
}
