com.eduworks.ec.array

Class EcAsyncHelper<T>

java.lang.Object

com.eduworks.ec.array.EcAsyncHelper<T>

public class EcAsyncHelper<T>
extends Object

Pattern (probably similar to Promise) that provides fine grained control over asynchronous execution. Will iterate over all items in an array and perform 'each(item,callback)'. Every 'each' needs to call the callback. This callback can be passed down through several asynchronous calls. When all callbacks have been called, 'after(array)' is called.

Author:

fritz.ray@eduworks.com

Field Summary

Fields

Modifier and Type	Field and Description
Integer	counter Counter that counts down when each callback is called.
static String	scriptPath

Constructor Summary

Constructors

Constructor and Description
EcAsyncHelper()

Method Summary

Modifier and Type	Method and Description
void	each(org.stjs.javascript.Array<T> array, org.stjs.javascript.functions.Callback2<T,org.stjs.javascript.functions.Callback0> each, org.stjs.javascript.functions.Callback1<org.stjs.javascript.Array<T>> after) "Each" method.
void	eachSet(org.stjs.javascript.Array<T> array, org.stjs.javascript.functions.Callback2<T,org.stjs.javascript.functions.Callback1> each, org.stjs.javascript.functions.Callback1<org.stjs.javascript.Array<T>> after) "Each" method.
org.stjs.javascript.functions.Callback1<String>	failWithCallback(org.stjs.javascript.functions.Callback1<String> failure, org.stjs.javascript.functions.Callback0 callback)
void	finish() Stops any remaining objects from being iterated over, if they have not already.
boolean	isStopped() Is preventing 'after' from being called?
static org.stjs.javascript.functions.Callback1<String>	setNull(org.stjs.javascript.functions.Callback1 set)
void	stop() Stops any remaining objects from being iterated over, if they have not already.

Methods inherited from class java.lang.Object

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

Field Detail

scriptPath

public static String scriptPath

counter

public Integer counter

Counter that counts down when each callback is called. Lots of tricks can be done to cause after to proc in different ways.

Constructor Detail

EcAsyncHelper

public EcAsyncHelper()

Method Detail

setNull

public static org.stjs.javascript.functions.Callback1<String> setNull(org.stjs.javascript.functions.Callback1 set)

each

public void each(org.stjs.javascript.Array<T> array,
                 org.stjs.javascript.functions.Callback2<T,org.stjs.javascript.functions.Callback0> each,
                 org.stjs.javascript.functions.Callback1<org.stjs.javascript.Array<T>> after)

"Each" method. See class description.

Parameters:

{Array} - array Array to iterate over.

{function(item,callback)} - each Method that gets invoked per item in the array.

{function(array)} - after Method invoked when all callbacks are called.

eachSet

public void eachSet(org.stjs.javascript.Array<T> array,
                    org.stjs.javascript.functions.Callback2<T,org.stjs.javascript.functions.Callback1> each,
                    org.stjs.javascript.functions.Callback1<org.stjs.javascript.Array<T>> after)

"Each" method. Allows for replacing values in the array. See class description.

Parameters:

{Array} - array Array to iterate over.

{function(item,callback)} - each Method that gets invoked per item in the array.

{function(array)} - after Method invoked when all callbacks are called.

failWithCallback

public org.stjs.javascript.functions.Callback1<String> failWithCallback(org.stjs.javascript.functions.Callback1<String> failure,
                                                                        org.stjs.javascript.functions.Callback0 callback)

stop

public void stop()

Stops any remaining objects from being iterated over, if they have not already. Will prevent 'after' from being called.

finish

public void finish()

Stops any remaining objects from being iterated over, if they have not already. Will allow 'after' to be called.

isStopped

public boolean isStopped()

Is preventing 'after' from being called?

Returns:

whether it is stopped.