seda.sandStorm.api
Class SinkClosedEvent

java.lang.Object
  extended by seda.sandStorm.api.SinkClosedEvent
All Implemented Interfaces:
QueueElementIF

public class SinkClosedEvent
extends java.lang.Object
implements QueueElementIF

This event indicates that a sink has closed, either intentionally by the application, or unintentionally, due to an error condition. A sink is considered closed when it is no longer being serviced.

As opposed to SinkClosedException (which is thrown immediately if one tries to enqueue onto a closed sink), this event is pushed to a stage if a sink closes asynchronously (that is, without being requested by the application), or some time after the original enqueue occurred.

See Also:
SinkClosedException

Field Summary
 SinkIF sink
          The sink that closed.
 
Constructor Summary
SinkClosedEvent(SinkIF sink)
          Create a new SinkClosedEvent with the given sink.
 
Method Summary
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

sink

public SinkIF sink
The sink that closed.

Constructor Detail

SinkClosedEvent

public SinkClosedEvent(SinkIF sink)
Create a new SinkClosedEvent with the given sink.

Method Detail

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object