org.cytoscape.task.create

Interface NewSessionTaskFactory

All Superinterfaces:

TaskFactory

public interface NewSessionTaskFactory
extends TaskFactory

This interface provides a task iterator for creating a new session.

Cytoscape Backwards Compatibility (API Interface): We expect that this interface will be used but not implemented by developers using this interface. As such, we reserve the right to add methods to the interface as part of minor version upgrades. We will not remove methods for any changes other than major version upgrades.

Module: core-task-api

To use this in your app, include the following dependency in your POM:

<dependency>
    <groupId>org.cytoscape</groupId>
    <artifactId>core-task-api</artifactId>
</dependency>

Method Summary

Modifier and Type	Method and Description
TaskIterator	createTaskIterator(boolean destroyCurrentSession) Creates a task iterator for creating a new session and destroying the current session based on the input.

Methods inherited from interface org.cytoscape.work.TaskFactory

createTaskIterator, isReady

Method Detail

createTaskIterator

TaskIterator createTaskIterator(boolean destroyCurrentSession)

Creates a task iterator for creating a new session and destroying the current session based on the input.

Parameters:

destroyCurrentSession - Whether or not to destroy the current session.

Returns:

A TaskIterator object containing one or more Task objects to execute.