com.google.common.eventbus

Class AnnotatedSubscriberFinder

java.lang.Object

com.google.common.eventbus.AnnotatedSubscriberFinder

All Implemented Interfaces:

SubscriberFindingStrategy

class AnnotatedSubscriberFinder
extends java.lang.Object
implements SubscriberFindingStrategy

A SubscriberFindingStrategy for collecting all event subscriber methods that are marked with the Subscribe annotation.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	AnnotatedSubscriberFinder.MethodIdentifier

Field Summary

Fields

Modifier and Type	Field and Description
private static LoadingCache<java.lang.Class<?>,ImmutableList<java.lang.reflect.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.

Constructor Summary

Constructors

Constructor and Description
AnnotatedSubscriberFinder()

Method Summary

Modifier and Type	Method and Description
Multimap<java.lang.Class<?>,EventSubscriber>	findAllSubscribers(java.lang.Object listener) Finds all suitable event subscriber methods in source, organizes them by the type of event they handle, and wraps them in EventSubscriber instances.
private static ImmutableList<java.lang.reflect.Method>	getAnnotatedMethods(java.lang.Class<?> clazz)
private static ImmutableList<java.lang.reflect.Method>	getAnnotatedMethodsInternal(java.lang.Class<?> clazz)
private static EventSubscriber	makeSubscriber(java.lang.Object listener, java.lang.reflect.Method method) Creates an EventSubscriber for subsequently calling method on listener.
private static boolean	methodIsDeclaredThreadSafe(java.lang.reflect.Method method) Checks whether method is thread-safe, as indicated by the AllowConcurrentEvents annotation.

Methods inherited from class java.lang.Object

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

Field Detail

subscriberMethodsCache

private static final LoadingCache<java.lang.Class<?>,ImmutableList<java.lang.reflect.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.

Constructor Detail

AnnotatedSubscriberFinder

AnnotatedSubscriberFinder()

Method Detail

findAllSubscribers

public Multimap<java.lang.Class<?>,EventSubscriber> findAllSubscribers(java.lang.Object listener)

Finds all suitable event subscriber methods in source, organizes them by the type of event they handle, and wraps them in EventSubscriber instances. This implementation finds all methods marked with a Subscribe annotation.

Specified by:

findAllSubscribers in interface SubscriberFindingStrategy

Parameters:

listener - object whose subscribers are desired.

Returns:

EventSubscriber objects for each subscriber method, organized by event type.

getAnnotatedMethods

private static ImmutableList<java.lang.reflect.Method> getAnnotatedMethods(java.lang.Class<?> clazz)

getAnnotatedMethodsInternal

private static ImmutableList<java.lang.reflect.Method> getAnnotatedMethodsInternal(java.lang.Class<?> clazz)

makeSubscriber

private static EventSubscriber makeSubscriber(java.lang.Object listener,
                                              java.lang.reflect.Method method)

Creates an EventSubscriber for subsequently calling method on listener. Selects an EventSubscriber implementation based on the annotations on method.

Parameters:

listener - object bearing the event subscriber method.

method - the event subscriber method to wrap in an EventSubscriber.

Returns:

an EventSubscriber that will call method on listener when invoked.

methodIsDeclaredThreadSafe

private static boolean methodIsDeclaredThreadSafe(java.lang.reflect.Method method)

Checks whether method is thread-safe, as indicated by the AllowConcurrentEvents annotation.

Parameters:

method - subscriber method to check.

Returns:

true if subscriber is marked as thread-safe, false otherwise.