JAL-3878 Add javadocs to created classes and reformat code.

[jalview.git] / src / jalview / ws2 / ResultSupplier.java

diff --git a/src/jalview/ws2/ResultSupplier.java b/src/jalview/ws2/ResultSupplier.java
index 3642d8e..68979c2 100644 (file)
--- a/src/jalview/ws2/ResultSupplier.java
+++ b/src/jalview/ws2/ResultSupplier.java
@@ -7,6 +7,17 @@ import jalview.api.AlignViewportI;
 import jalview.datamodel.AlignmentI;
 import jalview.datamodel.SequenceI;
 
+/**
+ * A generic function which supplies job result from the remote job to the
+ * worker object when the job is finished. Typically, the interface is
+ * implemented by one of the {@link WebServiceI} object methods and passed to
+ * the {@link WebServiceWorkerI} object on its creation.
+ * 
+ * @author mmwarowny
+ *
+ * @param <T>
+ *          result type
+ */
 @FunctionalInterface
 public interface ResultSupplier<T>
 {