org.cytoscape.event

Class AbstractCyPayloadEvent<T,P>

java.lang.Object

org.cytoscape.event.AbstractCyEvent<T>

org.cytoscape.event.AbstractCyPayloadEvent<T,P>

Type Parameters:

T - the generic type of the source object.

P - the generic type of the payloads.

All Implemented Interfaces:

CyEvent<T>, CyPayloadEvent<T,P>

Direct Known Subclasses:

AboutToRemoveEdgeViewsEvent, AboutToRemoveNodeViewsEvent, AddedEdgesEvent, AddedEdgeViewsEvent, AddedNodesEvent, AddedNodeViewsEvent, RowsCreatedEvent, RowsSetEvent, ViewChangedEvent, VisualMappingFunctionChangedEvent, VisualStyleChangedEvent

public abstract class AbstractCyPayloadEvent<T,P>
extends AbstractCyEvent<T>
implements CyPayloadEvent<T,P>

A base implementation of CyPayloadEvent that can be used by events.

Cytoscape Backwards Compatibility (Abstract Class): This class is abstract and meant to 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: event-api

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

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

Constructor Summary

Constructors

Constructor and Description
AbstractCyPayloadEvent(T source, Class<?> listenerClass, Collection<P> payload) Constructor.

Method Summary

Modifier and Type	Method and Description
Collection<P>	getPayloadCollection() Returns an unmodifiable collection of payload objects.

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

Methods inherited from interface org.cytoscape.event.CyEvent

getListenerClass, getSource

Constructor Detail

AbstractCyPayloadEvent

public AbstractCyPayloadEvent(T source,
                              Class<?> listenerClass,
                              Collection<P> payload)

Constructor.

Parameters:

source - The event source object.

listenerClass - The listener class for this event.

payload - A collection of payload objects. May be empty, but not null!

Method Detail

getPayloadCollection

public Collection<P> getPayloadCollection()

Returns an unmodifiable collection of payload objects.

Specified by:

getPayloadCollection in interface CyPayloadEvent<T,P>

Returns:

an unmodifiable collection of payload objects.