org.fujion.event

Class EventUtil

java.lang.Object

org.fujion.event.EventUtil

public class EventUtil
extends Object

Static methods for manipulating events.

Method Summary

Modifier and Type	Method and Description
static Class<? extends Event>	getEventClass(String eventType) Returns the implementation class for the specified event type.
static String	getEventType(Class<? extends Event> eventClass) Returns the event type given the implementation class.
static String	getEventType(ClientRequest request) Extracts the event type from the client request.
static Method	getHandler(String handlerName, Object instance, Event event) Returns a suitable handler method for an event.
static boolean	hasEvent(ClientRequest request) Returns true if the client request contains an event.
static boolean	hasEvent(ClientRequest request, String eventType) Returns true if the client request contains an event of the specified type.
static boolean	invokeHandler(String handlerName, Object instance, Event event) Invokes an event handler.
static void	post(Event event) Queues an event for later processing.
static void	post(Page page, Event event) Queues an event for later processing.
static Event	post(Page page, String eventName, BaseComponent target, Object data) Creates and posts an event for later delivery.
static Event	post(String eventName, BaseComponent target, Object data) Creates and posts an event for later delivery.
static void	send(Event event) Sends an event to its designated target.
static void	send(Event event, BaseComponent target) Sends an event to the specified target.
static Event	send(String eventName, BaseComponent target, Object data) Creates and sends an event to the specified target.
static String	stripOn(String eventType) Strips the "on" prefix from an event type, if one is present.
static Event	toEvent(ClientRequest request) Extracts an event from the client request.
static Event	toEvent(String eventType) Creates an event from the specified event type.

Methods inherited from class java.lang.Object

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

Method Detail

send

public static void send(Event event)

Sends an event to its designated target.

Parameters:

event - The event to send. If the event's designated target is null, the event is sent to the page in the current execution context.

send

public static void send(Event event,
                        BaseComponent target)

Sends an event to the specified target.

Parameters:

event - The event to send.

target - The target for the event. If the target is null, the event is sent to the page in the current execution context.

send

public static Event send(String eventName,
                         BaseComponent target,
                         Object data)

Creates and sends an event to the specified target.

Parameters:

eventName - The event name.

target - The event target.

data - Optional event data.

Returns:

The newly created event.

post

public static void post(Event event)

Queues an event for later processing.

Parameters:

event - The event to queue.

post

public static void post(Page page,
                        Event event)

Queues an event for later processing.

Parameters:

page - Page owning the target queue.

event - The event to queue.

post

public static Event post(String eventName,
                         BaseComponent target,
                         Object data)

Creates and posts an event for later delivery.

Parameters:

eventName - The event name.

target - The event target.

data - Optional event data.

Returns:

The newly created event.

post

public static Event post(Page page,
                         String eventName,
                         BaseComponent target,
                         Object data)

Creates and posts an event for later delivery.

Parameters:

page - Page owning the target queue.

eventName - The event name.

target - The event target.

data - Optional event data.

Returns:

The newly created event.

getEventClass

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

Returns the implementation class for the specified event type. If there is no implementation specific to the event type, the Event class will be returned.

Parameters:

eventType - The event type (with or without the "on" prefix).

Returns:

The implementation class for the event type (never null).

getEventType

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

Returns the event type given the implementation class.

Parameters:

eventClass - The event class.

Returns:

The corresponding event type, or null if none.

stripOn

public static String stripOn(String eventType)

Strips the "on" prefix from an event type, if one is present.

Parameters:

eventType - The event type.

Returns:

The event type stripped of the "on" prefix.

invokeHandler

public static boolean invokeHandler(String handlerName,
                                    Object instance,
                                    Event event)

Invokes an event handler.

Parameters:

handlerName - The name of the handler method.

instance - The instance implementing the handler method.

event - The event.

Returns:

True if the event was handled.

getHandler

public static Method getHandler(String handlerName,
                                Object instance,
                                Event event)

Returns a suitable handler method for an event. First, it searches for a method with a single argument that assignment-compatible with the event. Failing that, it searches for a method with no arguments. Failing that, it returns null.

Parameters:

handlerName - The name of the handler method (defaults to a method with the same name as the event type).

instance - The instance implementing the handler method.

event - The event.

Returns:

The handler method, or null if a suitable method could not be found.

hasEvent

public static boolean hasEvent(ClientRequest request)

Returns true if the client request contains an event.

Parameters:

request - The client request.

Returns:

True if the request contains an event.

hasEvent

public static boolean hasEvent(ClientRequest request,
                               String eventType)

Returns true if the client request contains an event of the specified type.

Parameters:

request - The client request.

eventType - The event type.

Returns:

True if the request contains an event of the specified type.

toEvent

public static Event toEvent(ClientRequest request)

Extracts an event from the client request.

Parameters:

request - The client request.

Returns:

The extracted event.

Throws:

IllegalArgumentException - If the request does not contain an event.

getEventType

public static String getEventType(ClientRequest request)

Extracts the event type from the client request.

Parameters:

request - The client request.

Returns:

The event type.

toEvent

public static Event toEvent(String eventType)

Creates an event from the specified event type. If an event class exists for the specified type, will create an event of that class. Otherwise, will create a generic event.

Parameters:

eventType - The event type.

Returns:

The newly created event.