Author: ruschein
Date: 2010-10-20 09:29:29 -0700 (Wed, 20 Oct 2010)
New Revision: 22307
Modified:
core3/work-api/trunk/src/main/java/org/cytoscape/work/TaskFactory.java
core3/work-api/trunk/src/main/java/org/cytoscape/work/Tunable.java
core3/work-api/trunk/src/main/java/org/cytoscape/work/TunableHandlerFactory.java
Log:
More Javadoc improvements.
Modified: core3/work-api/trunk/src/main/java/org/cytoscape/work/TaskFactory.java
===================================================================
--- core3/work-api/trunk/src/main/java/org/cytoscape/work/TaskFactory.java
2010-10-19 23:36:41 UTC (rev 22306)
+++ core3/work-api/trunk/src/main/java/org/cytoscape/work/TaskFactory.java
2010-10-20 16:29:29 UTC (rev 22307)
@@ -2,8 +2,16 @@
/**
- * Returns an instance of a TaskIterator. Intended to be
+ * Returns an instance of a {...@link TaskIterator}. Intended to be
* used as an OSGi service, singleton, every type of <code>Task</code> has
one.
+ * <br />
+ * Let's say you'd like to do some kind of processing, let's call it "X".
Then you would create a
+ * class called XTask, where the processing would be taking place in XTask's
run() method. Assuming
+ * X needs to have two types of data, let's call them Y and Z, in order to
control its behaviour.
+ * This would imply that XTask's constructor should take an X and a Y as
parameters. And XTaskFactory
+ * should have setY() and setZ() methods. XTaskFactory's getTaskIterator()
method would then construct
+ * an XTask with the Y and Z that it has available and create a {...@link
TaskIterator} with this single Task to
+ * iterate over.
*/
public interface TaskFactory {
/** @return an iterator returning a sequence of <code>Task</code>s.
Modified: core3/work-api/trunk/src/main/java/org/cytoscape/work/Tunable.java
===================================================================
--- core3/work-api/trunk/src/main/java/org/cytoscape/work/Tunable.java
2010-10-19 23:36:41 UTC (rev 22306)
+++ core3/work-api/trunk/src/main/java/org/cytoscape/work/Tunable.java
2010-10-20 16:29:29 UTC (rev 22307)
@@ -102,10 +102,10 @@
* Here is an example of how to add dependencies between
<code>Tunables<code> :
*
* <code>
- * @Tunable(description="Type")
+ * @Tunable(description="Type")
* public boolean type = false;
*
- * @Tunable(description="Host name",dependsOn="type=true")
+ * @Tunable(description="Host name",dependsOn="type=true")
* public String hostname="";
* </code>
* </pre></p>
Modified:
core3/work-api/trunk/src/main/java/org/cytoscape/work/TunableHandlerFactory.java
===================================================================
---
core3/work-api/trunk/src/main/java/org/cytoscape/work/TunableHandlerFactory.java
2010-10-19 23:36:41 UTC (rev 22306)
+++
core3/work-api/trunk/src/main/java/org/cytoscape/work/TunableHandlerFactory.java
2010-10-20 16:29:29 UTC (rev 22307)
@@ -9,7 +9,7 @@
* Provides a factory to create <code>Handlers</code> depending on their type.
* <code>Handlers</code> will be generated for Fields and Methods in the class
that contains the <code>Tunables</code>.
*
- * @param <TH> <code>TunableHandler</code> that will be created by this
factory. They will contain the informations
+ * @param <T> <code>TunableHandler</code> that will be created by this
factory. They will contain the informations
* provided by the <code>Tunable</code> annotations and the Object itself.
* @author Pasteur
*/
@@ -21,7 +21,7 @@
* @param field Field that need to have a <code>Handler</code>
* @param instance the object on which we want to read/write the
Field <code>field</code>
* @param tunable Tunable that contains all the information
concerning the user interface
- * @return TH the newly constructed <code>TunableHandler</code>
+ * @return T the newly constructed <code>TunableHandler</code>
*/
T getHandler(final Field field, final Object instance, final Tunable
tunable);
@@ -32,7 +32,7 @@
* @param getter a Method that need to be annotated with
<code>@Tunable</code>
* @param instance the object on which we want to invoke the
<code>setter</code> and <code>getter</code> methods
* @param tunable Tunable that contains all the information
concerning the user interface
- * @return TH the newly constructed <code>TunableHandler</code>
+ * @return T the newly constructed <code>TunableHandler</code>
*/
T getHandler(final Method setter, final Method getter, final Object
instance, final Tunable tunable);
}
\ No newline at end of file
--
You received this message because you are subscribed to the Google Groups
"cytoscape-cvs" group.
To post to this group, send email to [email protected].
To unsubscribe from this group, send email to
[email protected].
For more options, visit this group at
http://groups.google.com/group/cytoscape-cvs?hl=en.
