Author: ruschein
Date: 2010-10-22 16:26:54 -0700 (Fri, 22 Oct 2010)
New Revision: 22346
Modified:
core3/core-task-api/trunk/src/main/java/org/cytoscape/task/AbstractNetworkViewTaskFactory.java
core3/core-task-api/trunk/src/main/java/org/cytoscape/task/AbstractNodeViewTask.java
core3/core-task-api/trunk/src/main/java/org/cytoscape/task/AbstractNodeViewTaskFactory.java
Log:
Added missing Javadoc.
Modified:
core3/core-task-api/trunk/src/main/java/org/cytoscape/task/AbstractNetworkViewTaskFactory.java
===================================================================
---
core3/core-task-api/trunk/src/main/java/org/cytoscape/task/AbstractNetworkViewTaskFactory.java
2010-10-22 23:14:39 UTC (rev 22345)
+++
core3/core-task-api/trunk/src/main/java/org/cytoscape/task/AbstractNetworkViewTaskFactory.java
2010-10-22 23:26:54 UTC (rev 22346)
@@ -33,10 +33,15 @@
import org.cytoscape.view.model.CyNetworkView;
+/** Base class for all task factories that need to create tasks that will be
provisioned with a network view. */
public abstract class AbstractNetworkViewTaskFactory implements
NetworkViewTaskFactory {
-
+ /** The newtork view that will be passed into any tasks are are being
created by descendents of this class. */
protected CyNetworkView view;
+ /** Provides this class and its descendents with the network view that
will be passed into
+ * any tasks created by descendents of this class.
+ * @param view must be a non-null network view
+ */
public void setNetworkView(final CyNetworkView view) {
if ( view == null )
throw new NullPointerException("CyNetworkView is null");
Modified:
core3/core-task-api/trunk/src/main/java/org/cytoscape/task/AbstractNodeViewTask.java
===================================================================
---
core3/core-task-api/trunk/src/main/java/org/cytoscape/task/AbstractNodeViewTask.java
2010-10-22 23:14:39 UTC (rev 22345)
+++
core3/core-task-api/trunk/src/main/java/org/cytoscape/task/AbstractNodeViewTask.java
2010-10-22 23:26:54 UTC (rev 22346)
@@ -34,11 +34,19 @@
import org.cytoscape.work.AbstractTask;
+/** The base class for all tasks that need to operate on a node view and
possibly its associated network view.
+ */
public abstract class AbstractNodeViewTask extends AbstractTask {
+ /** The node view that descendents of this class will operate on. */
+ final protected View<CyNode> nodeView;
- final protected View<CyNode> nodeView;
+ /** The network view that descendents of this class will operate on. */
final protected CyNetworkView netView;
+ /** Base class constructor for all tasks that need to operate on a node
view and possibly its associated network view.
+ * @param nodeView a non-null node view that descendents of this
class will operate on
+ * @param netView the non-null network that is associated with
{...@link #nodeView}
+ */
public AbstractNodeViewTask(final View<CyNode> nodeView, final
CyNetworkView netView) {
if ( nodeView == null )
throw new NullPointerException("NodeView is null");
Modified:
core3/core-task-api/trunk/src/main/java/org/cytoscape/task/AbstractNodeViewTaskFactory.java
===================================================================
---
core3/core-task-api/trunk/src/main/java/org/cytoscape/task/AbstractNodeViewTaskFactory.java
2010-10-22 23:14:39 UTC (rev 22345)
+++
core3/core-task-api/trunk/src/main/java/org/cytoscape/task/AbstractNodeViewTaskFactory.java
2010-10-22 23:26:54 UTC (rev 22346)
@@ -33,10 +33,21 @@
import org.cytoscape.model.CyNode;
+/** Base class for all task factories that create tasks that need to be
provisioned with a node view
+ * and its associated network view.
+ */
public abstract class AbstractNodeViewTaskFactory implements
NodeViewTaskFactory {
+ /** The network view that will be used to provision tasks that are
being created by descendents of this class. */
protected CyNetworkView netView;
+
+ /** The node view that will be used to provision tasks that are being
created by descendents of this class. */
protected View<CyNode> nodeView;
+ /** Provisions descendents of this class with a node view and its
associated network view
+ * that will be used to pass to created tasks.
+ * @param nodeView a non-null node view
+ * @param netView the non-null network view associated with
{...@link #nodeView}
+ */
public void setNodeView(final View<CyNode> nodeView, final
CyNetworkView netView) {
if (nodeView == null)
throw new NullPointerException("NodeView is null");
--
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.
