xyz.thepathfinder.android

Class ClusterListener

java.lang.Object

xyz.thepathfinder.android.Listener<Cluster>

xyz.thepathfinder.android.ClusterListener

public abstract class ClusterListener
extends Listener<Cluster>

The ClusterListener interface gives developers access to notifications when a cluster is modified. These notifications include changes to commodity, sub-clusters, and transports. They also include route notifications and others.

Constructor Summary

Constructors

Constructor and Description
ClusterListener()

Method Summary

Methods

Modifier and Type	Method and Description
void	commoditiesUpdated(Collection<Commodity> commodities) Invoked when at least one commodity was updated by a message.
void	commodityAdded(Commodity commodity) Invoked when a commodity was added to the cluster by a message.
void	commodityRemoved(Commodity commodity) Invoked when a commodity was removed from the cluster by a message.
void	commodityUpdated(Commodity commodity) Invoked when a commodity in this cluster was updated by a message.
void	routed(List<Route> routes) Invoked when the cluster receives a routed message.
void	subclusterAdded(Cluster cluster) Invoked when a subcluster was added to this cluster by a message.
void	subclusterRemoved(Cluster cluster) Invoked when a subcluster was removed from this cluster by a message.
void	subclustersUpdated(Collection<Cluster> clusters) Invoked when a sublcuster was updated from this cluster by a message.
void	subclusterUpdated(Cluster cluster) Invoked when a subcluster was updated from this cluster by a message.
void	transportAdded(Transport transport) Invoked when a transport was added to this cluster by a message.
void	transportRemoved(Transport transport) Invoked when a transport was removed from this cluster by a message.
void	transportsUpdated(Collection<Transport> transports) Invoked when a transport was updated in this cluster by a message.
void	transportUpdated(Transport transport) Invoked when a transport was updated in this cluster by a message.

Methods inherited from class xyz.thepathfinder.android.Listener

connected, created, deleted, error, routeSubscribed, routeUnsubscribed, subscribed, unsubscribed, updated

Methods inherited from class java.lang.Object

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

Constructor Detail

ClusterListener

public ClusterListener()

Method Detail

routed

public void routed(List<Route> routes)

Invoked when the cluster receives a routed message.

Parameters:

routes - the cluster's routes as a list.

commodityAdded

public void commodityAdded(Commodity commodity)

Invoked when a commodity was added to the cluster by a message.

Parameters:

commodity - added to the cluster.

commodityRemoved

public void commodityRemoved(Commodity commodity)

Invoked when a commodity was removed from the cluster by a message.

Parameters:

commodity - removed from the cluster.

commodityUpdated

public void commodityUpdated(Commodity commodity)

Invoked when a commodity in this cluster was updated by a message.

Parameters:

commodity - the commodity updated.

commoditiesUpdated

public void commoditiesUpdated(Collection<Commodity> commodities)

Invoked when at least one commodity was updated by a message.

Parameters:

commodities - that belong to this cluster.

subclusterAdded

public void subclusterAdded(Cluster cluster)

Invoked when a subcluster was added to this cluster by a message.

Parameters:

cluster - the subcluster added to this cluster.

subclusterRemoved

public void subclusterRemoved(Cluster cluster)

Invoked when a subcluster was removed from this cluster by a message.

Parameters:

cluster - the subcluster removed from this cluster.

subclusterUpdated

public void subclusterUpdated(Cluster cluster)

Invoked when a subcluster was updated from this cluster by a message. Note, this update doesn't recurse up the cluster tree. If the cluster "/default/c1/c2/c3" receives an update message, both cluster "/defautl/c1/c2/c3" and "/default/c1/c2" will receive this message. This is because "/default/c1/c2/c3 was modified by the received message, but "/default/c1/c2" was not modified.

Parameters:

cluster - the cluster updated.

subclustersUpdated

public void subclustersUpdated(Collection<Cluster> clusters)

Invoked when a sublcuster was updated from this cluster by a message. Note, this update doesn't recurse up the cluster tree. If the cluster "/default/c1/c2/c3" receives an update message, both cluster "/defautl/c1/c2/c3" and "/default/c1/c2" will receive this message. This is because "/default/c1/c2/c3 was modified by the received message, but "/default/c1/c2" was not modified.

Parameters:

clusters - the subclusters that belong to this cluster.

transportAdded

public void transportAdded(Transport transport)

Invoked when a transport was added to this cluster by a message.

Parameters:

transport - added by the message.

transportRemoved

public void transportRemoved(Transport transport)

Invoked when a transport was removed from this cluster by a message.

Parameters:

transport - removed by the message.

transportUpdated

public void transportUpdated(Transport transport)

Invoked when a transport was updated in this cluster by a message.

Parameters:

transport - updated by the message.

transportsUpdated

public void transportsUpdated(Collection<Transport> transports)

Invoked when a transport was updated in this cluster by a message.

Parameters:

transports - that belong to this cluster.