Package org.cytoscape.session.events

Class SessionSaveCancelledEvent

java.lang.Object
org.cytoscape.event.AbstractCyEvent<Object>
org.cytoscape.session.events.SessionSaveCancelledEvent
All Implemented Interfaces:
CyEvent<Object>
public final class SessionSaveCancelledEvent extends AbstractCyEvent<Object>
This event is fired when a session save task is cancelled, which can also happen because of exceptions.

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: session-api

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

<dependency>
    <groupId>org.cytoscape</groupId>
    <artifactId>session-api</artifactId>
</dependency>

  • Constructor Details

    • SessionSaveCancelledEvent

      public SessionSaveCancelledEvent​(Object source)
      Constructor.
      Parameters:
      source - The object that fired this event.

    • SessionSaveCancelledEvent

      public SessionSaveCancelledEvent​(Object source, Exception exception)
      Use this constructor if the session save was cancelled because of an exception.
      Parameters:
      source - The object that fired this event.
      exception - The Exception that interrupted the session save task.

  • Method Details

    • getException

      public Exception getException()
      Returns:
      The exception that cancelled the session save task or null, if it was not interrupted by an exception.