org.fujion.annotation

Class EventTypeScanner

java.lang.Object

org.fujion.annotation.AbstractClassScanner<Event,EventType>

org.fujion.annotation.EventTypeScanner

public class EventTypeScanner
extends AbstractClassScanner<Event,EventType>

Builds a map of event types to implementation classes by scanning class annotations.

Method Summary

Modifier and Type	Method and Description
protected void	doScanClass(Class<Event> eventClass) Creates mapping between event type and its implementation class.
Class<? extends Event>	getEventClass(String eventType) Returns an implementation class given an event type.
String	getEventType(Class<? extends Event> eventClass) Given an event class, returns the event type implemented by that class.
Set<String>	getEventTypes() Returns the set of registered event types.
static EventTypeScanner	getInstance() Returns a singleton instance of the event type scanner.

Methods inherited from class org.fujion.annotation.AbstractClassScanner

scanClass, scanClass, scanPackage, scanPackage

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static EventTypeScanner getInstance()

Returns a singleton instance of the event type scanner.

Returns:

Singleton instance of the event type scanner.

doScanClass

protected void doScanClass(Class<Event> eventClass)

Creates mapping between event type and its implementation class.

Specified by:

doScanClass in class AbstractClassScanner<Event,EventType>

Parameters:

eventClass - Class containing EventType annotations.

getEventClass

public Class<? extends Event> getEventClass(String eventType)

Returns an implementation class given an event type. Will never return null; for any event types that do not have an explicit implementation class this method will return a generic Event class.

Parameters:

eventType - The event type whose implementation class is sought.

Returns:

The implementation class.

getEventType

public String getEventType(Class<? extends Event> eventClass)

Given an event class, returns the event type implemented by that class.

Parameters:

eventClass - An event class.

Returns:

The event type, or null if none is associated with the class.

getEventTypes

public Set<String> getEventTypes()

Returns the set of registered event types.

Returns:

The set of registered event types.