Top Description Inners Fields Constructors Methods
com.google.common.eventbus

pack-priv final Class SubscriberRegistry

extends Object
Class Inheritance
Annotations
@ElementTypesAreNonnullByDefault
Static Imports
com.google.common.base.Preconditions.checkArgument, .Preconditions.checkNotNull, .Throwables.throwIfUnchecked

Registry of subscribers to a single event bus.
Author
Colin Decker

Nested and Inner Type Summary

Modifier and TypeClass and Description
private static class

Field Summary

Modifier and TypeField and Description
private final EventBus
bus

The event bus this registry belongs to.

private static final LoadingCache<Class<?>, ImmutableSet<Class<?>>>
flattenHierarchyCache

Global cache of classes to their flattened hierarchy of supertypes.

private static final LoadingCache<Class<?>, ImmutableList<Method>>
subscriberMethodsCache

A thread-safe cache that contains the mapping from each class to all methods in that class and all super-classes, that are annotated with @Subscribe.

private final ConcurrentMap<Class<?>, CopyOnWriteArraySet<Subscriber>>
subscribers

All registered subscribers, indexed by event type.

Constructor Summary

AccessConstructor and Description
pack-priv

Method Summary

Modifier and TypeMethod and Description
private Multimap<Class<?>, Subscriber>
findAllSubscribers(Object listener)

Returns all subscribers for the given listener grouped by the type of event they subscribe to.

pack-priv static ImmutableSet<Class<?>>
flattenHierarchy(Class<?> concreteClass)

Flattens a class's type hierarchy into a set of Class objects including all superclasses (transitively) and all interfaces implemented by these superclasses.

private static ImmutableList<Method>
private static ImmutableList<Method>
pack-priv Iterator<Subscriber>
getSubscribers(Object event)

Gets an iterator representing an immutable snapshot of all subscribers to the given event at the time this method is called.

pack-priv Set<Subscriber>
pack-priv void
register(Object listener)

Registers all subscriber methods on the given listener object.

pack-priv void
unregister(Object listener)

Unregisters all subscribers on the given listener object.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

busback to summary
private final EventBus bus

The event bus this registry belongs to.

Annotations
@Weak
flattenHierarchyCacheback to summary
private static final LoadingCache<Class<?>, ImmutableSet<Class<?>>> flattenHierarchyCache

Global cache of classes to their flattened hierarchy of supertypes.

subscriberMethodsCacheback to summary
private static final LoadingCache<Class<?>, ImmutableList<Method>> subscriberMethodsCache

A thread-safe cache that contains the mapping from each class to all methods in that class and all super-classes, that are annotated with @Subscribe. The cache is shared across all instances of this class; this greatly improves performance if multiple EventBus instances are created and objects of the same class are registered on all of them.

subscribersback to summary
private final ConcurrentMap<Class<?>, CopyOnWriteArraySet<Subscriber>> subscribers

All registered subscribers, indexed by event type.

The CopyOnWriteArraySet values make it easy and relatively lightweight to get an immutable snapshot of all current subscribers to an event without any locking.

Constructor Detail

SubscriberRegistryback to summary
pack-priv SubscriberRegistry(EventBus bus)

Method Detail

findAllSubscribersback to summary
private Multimap<Class<?>, Subscriber> findAllSubscribers(Object listener)

Returns all subscribers for the given listener grouped by the type of event they subscribe to.

flattenHierarchyback to summary
pack-priv static ImmutableSet<Class<?>> flattenHierarchy(Class<?> concreteClass)

Flattens a class's type hierarchy into a set of Class objects including all superclasses (transitively) and all interfaces implemented by these superclasses.

Annotations
@VisibleForTesting
getAnnotatedMethodsback to summary
private static ImmutableList<Method> getAnnotatedMethods(Class<?> clazz)
getAnnotatedMethodsNotCachedback to summary
private static ImmutableList<Method> getAnnotatedMethodsNotCached(Class<?> clazz)
getSubscribersback to summary
pack-priv Iterator<Subscriber> getSubscribers(Object event)

Gets an iterator representing an immutable snapshot of all subscribers to the given event at the time this method is called.

getSubscribersForTestingback to summary
pack-priv Set<Subscriber> getSubscribersForTesting(Class<?> eventType)
Annotations
@VisibleForTesting
registerback to summary
pack-priv void register(Object listener)

Registers all subscriber methods on the given listener object.

unregisterback to summary
pack-priv void unregister(Object listener)

Unregisters all subscribers on the given listener object.

com.google.common.eventbus back to summary

private final Class SubscriberRegistry.MethodIdentifier

extends Object
Class Inheritance
  • java.lang.Object
  • com.google.common.eventbus.SubscriberRegistry.MethodIdentifier

Field Summary

Modifier and TypeField and Description
private final String
private final List<Class<?>>

Constructor Summary

AccessConstructor and Description
pack-priv

Method Summary

Modifier and TypeMethod and Description
public boolean
equals(Object
the reference object with which to compare.
o
)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.
public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for the object.
Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAlltoStringwaitwaitwait

Field Detail

nameback to summary
private final String name
parameterTypesback to summary
private final List<Class<?>> parameterTypes

Constructor Detail

MethodIdentifierback to summary
pack-priv MethodIdentifier(Method method)

Method Detail

equalsback to summary
public boolean equals(Object o)

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
o: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
hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for the 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