Package org.cytoscape.work
Class FinishStatus
java.lang.Object
org.cytoscape.work.FinishStatus
Indicates the status of a task iterator when it has finished for
TaskObserver
s.Cytoscape Backwards Compatibility (Final Class): This class is final and therefore can't be extended by users. This means that we may add methods for minor version updates. Methods will only be removed for major version updates.
Module: work-api
To use this in your app, include the following dependency in your POM:
<dependency> <groupId>org.cytoscape</groupId> <artifactId>work-api</artifactId> </dependency>
-
Nested Class Summary
-
Constructor Summary
ModifierConstructorDescriptionprotected
FinishStatus
(FinishStatus.Type type, Task task, Exception exception) -
Method Summary
Modifier and TypeMethodDescriptionReturns the exception thrown by the task that failed, or null if the task iterator succeeded or was cancelled.static FinishStatus
Get aFinishStatus
instance that indicates success.getTask()
Returns the task that was cancelled or that had failed, or returns null if the task iterator succeeded.getType()
Specifies how the task iterator completed.static FinishStatus
newCancelled
(Task cancelledTask) Construct a newFinishStatus
object that indicates cancellation.static FinishStatus
Construct a newFinishStatus
object that indicates failure.
-
Constructor Details
-
FinishStatus
-
-
Method Details
-
getSucceeded
Get aFinishStatus
instance that indicates success. -
newCancelled
Construct a newFinishStatus
object that indicates cancellation.- Parameters:
cancelledTask
- The task that was cancelled by the user.
-
newFailed
Construct a newFinishStatus
object that indicates failure.- Parameters:
failedTask
- The task that failed.exception
- The exception that the task threw.
-
getType
Specifies how the task iterator completed. -
getTask
Returns the task that was cancelled or that had failed, or returns null if the task iterator succeeded. -
getException
Returns the exception thrown by the task that failed, or null if the task iterator succeeded or was cancelled.
-