Nested and Inner Type Summary

Modifier and Type	Class and Description
pack-priv static class	Subscriber.SynchronizedSubscriber Subscriber that synchronizes invocations of a method to ensure that only one thread may enter the method at a time.

Field Summary

Modifier and Type	Field and Description
private EventBus	bus The event bus this subscriber belongs to.
private final Executor	executor Executor to use for dispatching events to this subscriber.
private final Method	method Subscriber method.
pack-priv final Object	target The object with the subscriber method.

Constructor Summary

Access	Constructor and Description
private	Subscriber(EventBus bus, Object target, Method method)

Method Summary

Modifier and Type	Method and Description
private SubscriberExceptionContext	context(Object event) Gets the context for the given event.
pack-priv static Subscriber	create(EventBus bus, Object listener, Method method) Creates a `Subscriber` for `method` on `listener`.
pack-priv final void	dispatchEvent(Object event) Dispatches `event` to this subscriber using the proper executor.
public final boolean	equals(Object the reference object with which to compare. obj) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public final int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
pack-priv void	invokeSubscriberMethod(Object event) Invokes the subscriber method.
private static boolean	isDeclaredThreadSafe(Method method) Checks whether `method` is thread-safe, as indicated by the presence of the `AllowConcurrentEvents` annotation.

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll toString wait wait wait

Field Detail

bus	back to summary
private EventBus bus The event bus this subscriber belongs to. Annotations @Weak

executor	back to summary
private final Executor executor Executor to use for dispatching events to this subscriber.

method	back to summary
private final Method method Subscriber method.

target	back to summary
pack-priv final Object target The object with the subscriber method. Annotations @VisibleForTesting

Constructor Detail

Subscriber	back to summary
private Subscriber(EventBus bus, Object target, Method method)

Method Detail

context	back to summary
private SubscriberExceptionContext context(Object event) Gets the context for the given event.

create	back to summary
pack-priv static Subscriber create(EventBus bus, Object listener, Method method) Creates a `Subscriber` for `method` on `listener`.

dispatchEvent	back to summary
pack-priv final void dispatchEvent(Object event) Dispatches `event` to this subscriber using the proper executor.

equals back to summary

equals	back to summary
public final boolean equals(Object obj) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Parameters obj:Object the reference object with which to compare. Returns:boolean `true` if this object is the same as the obj argument; `false` otherwise. Annotations @Override

public final boolean equals(Object obj)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters

obj:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

hashCode back to summary

hashCode	back to summary
public final int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Returns:int a hash code value for this object Annotations @Override

public final int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int

a hash code value for this object

Annotations

@Override

invokeSubscriberMethod	back to summary
pack-priv void invokeSubscriberMethod(Object event) throws InvocationTargetException Invokes the subscriber method. This method can be overridden to make the invocation synchronized. Annotations @VisibleForTesting

invokeSubscriberMethod

back to summary

pack-priv void invokeSubscriberMethod(Object event) throws InvocationTargetException

Invokes the subscriber method. This method can be overridden to make the invocation synchronized.

Annotations

@VisibleForTesting

isDeclaredThreadSafe	back to summary
private static boolean isDeclaredThreadSafe(Method method) Checks whether `method` is thread-safe, as indicated by the presence of the `AllowConcurrentEvents` annotation.

com.google.common.eventbus back to summary

pack-priv final Class Subscriber.SynchronizedSubscriber

Class Inheritance

extends Subscriber

java.lang.Object
com.google.common.eventbus.Subscriber
com.google.common.eventbus.Subscriber.SynchronizedSubscriber

Annotations

@VisibleForTesting

Subscriber that synchronizes invocations of a method to ensure that only one thread may enter the method at a time.

Field Summary

Inherited from com.google.common.eventbus.Subscriber:: target

Constructor Summary

Access	Constructor and Description
private	SynchronizedSubscriber(EventBus bus, Object target, Method method)

Method Summary

Modifier and Type	Method and Description
pack-priv void	invokeSubscriberMethod(Object event) Overrides com.google.common.eventbus.Subscriber.invokeSubscriberMethod. Invokes the subscriber method.

Inherited from com.google.common.eventbus.Subscriber:: create dispatchEvent equals hashCode

Constructor Detail

SynchronizedSubscriber	back to summary
private SynchronizedSubscriber(EventBus bus, Object target, Method method)

Method Detail

invokeSubscriberMethod	back to summary
pack-priv void invokeSubscriberMethod(Object event) throws InvocationTargetException Overrides com.google.common.eventbus.Subscriber.invokeSubscriberMethod. Doc from com.google.common.eventbus.Subscriber.invokeSubscriberMethod. Invokes the subscriber method. This method can be overridden to make the invocation synchronized. Annotations @Override

invokeSubscriberMethod

back to summary

pack-priv void invokeSubscriberMethod(Object event) throws InvocationTargetException

Overrides com.google.common.eventbus.Subscriber.invokeSubscriberMethod.

Doc from com.google.common.eventbus.Subscriber.invokeSubscriberMethod.

Invokes the subscriber method. This method can be overridden to make the invocation synchronized.

Annotations