com.google.common.eventbus

Class DeadEvent

java.lang.Object

com.google.common.eventbus.DeadEvent

@Beta
public class DeadEvent
extends Object

Wraps an event that was posted, but which had no subscribers and thus could not be delivered.

Registering a DeadEvent subscriber is useful for debugging or logging, as it can detect misconfigurations in a system's event distribution.

Since:

10.0

Author:

Cliff Biffle

Constructor Summary

Constructors

Constructor and Description
DeadEvent(Object source, Object event) Creates a new DeadEvent.

Method Summary

Modifier and Type	Method and Description
Object	getEvent() Returns the wrapped, 'dead' event, which the system was unable to deliver to any registered subscriber.
Object	getSource() Returns the object that originated this event (not the object that originated the wrapped event).
String	toString() Returns a string representation of the object.

Methods inherited from class java.lang.Object

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

Constructor Detail

DeadEvent

public DeadEvent(Object source,
                 Object event)

Creates a new DeadEvent.

Parameters:

source - object broadcasting the DeadEvent (generally the EventBus).

event - the event that could not be delivered.

Method Detail

getSource

public Object getSource()

Returns the object that originated this event (not the object that originated the wrapped event). This is generally an EventBus.

Returns:

the source of this event.

getEvent

public Object getEvent()

Returns the wrapped, 'dead' event, which the system was unable to deliver to any registered subscriber.

Returns:

the 'dead' event that could not be delivered.

toString

public String toString()

Description copied from class: java.lang.Object

Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.

The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:

 getClass().getName() + '@' + Integer.toHexString(hashCode())
 

Overrides:

toString in class Object

Returns:

a string representation of the object.