Cytoscape 3.0.1 API

Class AbstractCyPayloadEvent<T,P>

  extended by org.cytoscape.event.AbstractCyEvent<T>
      extended by 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, 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.

Constructor Summary
AbstractCyPayloadEvent(T source, Class<?> listenerClass, Collection<P> payload)
Method Summary
 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


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

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


public Collection<P> getPayloadCollection()
Returns an unmodifiable collection of payload objects.

Specified by:
getPayloadCollection in interface CyPayloadEvent<T,P>
an unmodifiable collection of payload objects.

Cytoscape 3.0.1 API

Copyright 2011 Cytoscape Consortium. All rights reserved.