Package org.opencms.gwt.client.util

Class CmsAsyncJoinHandler

java.lang.Object

org.opencms.gwt.client.util.CmsAsyncJoinHandler

public class CmsAsyncJoinHandler
extends Object

Helper class used to perform an action when multiple asynchronous tasks have finished.

To use this, first, for every action, add a token which uniquely identifies the action. Remove the corresponding token when the action is finished. When all tokens are removed, the final action will be executed.

Field Summary

Fields

Modifier and Type	Field	Description
protected Set<Object>	m_tokens	The set of tokens.

Constructor Summary

Constructors

Constructor	Description
CmsAsyncJoinHandler(Runnable joinAction)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
void	addTokens(Object... tokens)	Adds tokens.
void	removeToken(Object token)	Removes a token.

Methods inherited from class java.lang.Object

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

Field Details

m_tokens

protected Set<Object> m_tokens

The set of tokens.

Constructor Details

CmsAsyncJoinHandler

public CmsAsyncJoinHandler(Runnable joinAction)

Creates a new instance.

Parameters:

joinAction - the final action to execute

Method Details

addTokens

public void addTokens(Object... tokens)

Adds tokens.

Parameters:

tokens - the tokens to add

removeToken

public void removeToken(Object token)

Removes a token.

When all tokens have been removed, the final action is executed.

Parameters:

token - the token to remove