org.cytoscape.session.events

Class SessionLoadCancelledEvent

java.lang.Object

org.cytoscape.event.AbstractCyEvent<Object>

org.cytoscape.session.events.SessionLoadCancelledEvent

All Implemented Interfaces:

CyEvent<Object>

public final class SessionLoadCancelledEvent
extends AbstractCyEvent<Object>

This event is fired when a session load 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 Summary

Constructors

Constructor and Description
SessionLoadCancelledEvent(Object source) Constructor.
SessionLoadCancelledEvent(Object source, Exception exception) Use this constructor if the session load was cancelled because of an exception.

Method Summary

Modifier and Type	Method and Description
Exception	getException()

Methods inherited from class org.cytoscape.event.AbstractCyEvent

getListenerClass, getSource

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SessionLoadCancelledEvent

public SessionLoadCancelledEvent(Object source)

Constructor.

Parameters:

source - The object that fired this event.

SessionLoadCancelledEvent

public SessionLoadCancelledEvent(Object source,
                                 Exception exception)

Use this constructor if the session load was cancelled because of an exception.

Parameters:

source - The object that fired this event.

exception - The Exception that interrupted the session load task.

Method Detail

getException

public Exception getException()

Returns:

The exception that cancelled the session load task or null, if it was not interrupted by an exception.