com.digi.wva.async

Class EventFactory

java.lang.Object

com.digi.wva.async.EventFactory

public final class EventFactory
extends Object

Container for static factory function fromTCP(org.json.JSONObject) and common event enumeration(s).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EventFactory.Type Enumeration of the general types of events that can be sent by the WVA.

Method Summary

Methods

Modifier and Type	Method and Description
static com.digi.wva.internal.AbstractEvent<?>	fromTCP(JSONObject obj) This method is the preferred way of creating an event object.

Methods inherited from class java.lang.Object

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

Method Detail

fromTCP

public static com.digi.wva.internal.AbstractEvent<?> fromTCP(JSONObject obj)
                                                      throws JSONException

This method is the preferred way of creating an event object. It takes a JSON object from the EventChannel's object queue and transforms it into an event consumable by anything registered to the client. Any JSONObject can be sent through this method, but only objects of the correct format will produce a non-null object.

Parameters:

obj - JSONObject to be used in constructing a new Event object

Returns:

a new event object constructed from obj's data. The correct event class will be selected based on the values in obj

Throws:

JSONException - if obj is of a recognized format but has bad values