com.tuxisalive.api.TuxEventHandlers Class Reference

Collaboration diagram for com.tuxisalive.api.TuxEventHandlers:

Public Member Functions
	TuxEventHandlers ()
void	destroy ()
Boolean	insert (String eventName)
List< String >	getEventsNameList ()
TuxEventHandler	getEventHandler (String eventName)
Integer	register (String eventName, Object sender, String method)
Integer	register (String eventName, Object sender, String method, Object... condition)
Integer	register (String eventName, Integer idx, Object sender, String method, Object... condition)
void	unregister (String eventName, Integer idx)
void	storeContext ()
void	restoreContext ()
void	clearContext ()
void	updateState (String eventName, List< Object > state)
void	emit (String eventName, Object...args)
void	notify (String eventName, Object...args)
Boolean	waitCondition (String eventName, Double timeout, Object... condition)
void	clearPending ()

Private Attributes
Hashtable< Object, Object >	eventHt

Detailed Description

TuxEventsHandler is a container of TuxEventHandler objects.

Author

Remi Jocaille

Version

0.0.3

See also

TuxEventHandler

Constructor & Destructor Documentation

TuxEventHandlers()

com.tuxisalive.api.TuxEventHandlers.TuxEventHandlers

(

)

Constructor of class.

Member Function Documentation

clearContext()

void com.tuxisalive.api.TuxEventHandlers.clearContext

(

)

This method clears the configuration of the linked callbacks in the event handlers.

See also

TuxEventHandler::clearContext()

clearPending()

void com.tuxisalive.api.TuxEventHandlers.clearPending

(

)

Clear all pending wait.

See also

TuxEventHandler::clearPending()

destroy()

void com.tuxisalive.api.TuxEventHandlers.destroy

(

)

Destructor of class.

emit()

void com.tuxisalive.api.TuxEventHandlers.emit	(	String	eventName,
		Object...	args
	)

Emit a signal on the event handler with a set of parameters.

Parameters

eventName	name of the handler.
args	parameters.

See also

TuxEventHandler::emit(Object...)

getEventHandler()

TuxEventHandler com.tuxisalive.api.TuxEventHandlers.getEventHandler

(

String

eventName

)

Get an event handler by its name.

Parameters

eventName

name of the handler.

Returns

a TuxEventHandler object or null if the event name was not found.

getEventsNameList()

List<String> com.tuxisalive.api.TuxEventHandlers.getEventsNameList

(

)

Get the events name list.

Returns

The events name list.

insert()

Boolean com.tuxisalive.api.TuxEventHandlers.insert

(

String

eventName

)

Create and insert a new event handler in the container.

Parameters

eventName

name of the new event handler.

notify()

void com.tuxisalive.api.TuxEventHandlers.notify	(	String	eventName,
		Object...	args
	)

Emit a signal on the event handler with a set of parameters.

Parameters

eventName	name of the handler.
args	parameters.

See also

TuxEventHandler::notify()

register() [1/3]

Integer com.tuxisalive.api.TuxEventHandlers.register	(	String	eventName,
		Integer	idx,
		Object	sender,
		String	method,
		Object...	condition
	)

Register another callback at the place of a previous index.

Parameters

eventName	name of the event handler.
idx	the index of the callback
sender	parent object of the method.
method	method name as string.
condition	object array of the condition.

Returns

the index of the callback in the handler.

See also

TuxEventHandler::register(Integer, Object, String, Object...)

register() [2/3]

Integer com.tuxisalive.api.TuxEventHandlers.register	(	String	eventName,
		Object	sender,
		String	method
	)

Register a callback function to an event handler.

Parameters

eventName	name of the event handler.
sender	parent object of the method.
method	method name as string.

Returns

the index of the callback in the handler.

See also

TuxEventHandler::register(Object, String)

register() [3/3]

Integer com.tuxisalive.api.TuxEventHandlers.register	(	String	eventName,
		Object	sender,
		String	method,
		Object...	condition
	)

Register a callback function to an event handler.

Parameters

eventName	name of the event handler.
sender	parent object of the method.
method	method name as string.
condition	object array of the condition.

Returns

the index of the callback in the handler.

See also

TuxEventHandler::register(Object, String, Object...)

restoreContext()

void com.tuxisalive.api.TuxEventHandlers.restoreContext

(

)

This method restore from a stack the configuration of the linked callbacks in the event handlers.

See also

TuxEventHandler::restoreContext()

storeContext()

void com.tuxisalive.api.TuxEventHandlers.storeContext

(

)

This method store in a stack the configuration of the linked callbacks in the event handlers.

See also

TuxEventHandler::storeContext()

unregister()

void com.tuxisalive.api.TuxEventHandlers.unregister	(	String	eventName,
		Integer	idx
	)

Unregister a callback from an event handler.

Parameters

eventName	name of the event handler.
idx	index of the callback.

See also

TuxEventHandler::unregister

updateState()

void com.tuxisalive.api.TuxEventHandlers.updateState	(	String	eventName,
		List< Object >	state
	)

Get the events name list.

Returns

The events name list.

waitCondition()

Boolean com.tuxisalive.api.TuxEventHandlers.waitCondition	(	String	eventName,
		Double	timeout,
		Object...	condition
	)

Synchronize a condition with a specific event.

Parameters

eventName	name of the handler.
timeout	maximal delay to wait.
condition	object array of the condition.

Returns

the success of the waiting.

See also

TuxEventHandler::waitCondition(Double, Object...)

Member Data Documentation

eventHt

Hashtable<Object,Object> com.tuxisalive.api.TuxEventHandlers.eventHt

private

---

The documentation for this class was generated from the following file:

• com/tuxisalive/api/TuxEventHandlers.java