xal.tools.dispatch

Class DispatchGroup

java.lang.Object

xal.tools.dispatch.DispatchGroup

public class DispatchGroup
extends java.lang.Object

DispatchGroup

Constructor Summary

Constructors

Constructor and Description
DispatchGroup() Constructor

Method Summary

Modifier and Type	Method and Description
<ReturnType> void	addOperation(xal.tools.dispatch.DispatchOperation<ReturnType> operation) add an operation to this group
static <ReturnType> void	addOperationToCurrentGroups(xal.tools.dispatch.DispatchOperation<ReturnType> operation) add the operation to the current groups
static <ReturnType> void	addOperationToGroups(xal.tools.dispatch.DispatchOperation<ReturnType> operation, java.util.Set<DispatchGroup> groups) add the operation to the specified groups
<ReturnType> void	addOperationToThisGroupAndCurrentGroups(xal.tools.dispatch.DispatchOperation<ReturnType> operation) add the operation to this group and the current groups without double counting this group
void	await() synonym for waitForCompletion()
void	await(long timeout) synonym for waitForCompletionWithTimeout( timeout )
void	enter() Enter this group for addition of operations on the current thread
protected static java.util.Set<DispatchGroup>	getCurrentGroups() Get the set of current groups
void	leave() Leave this group to remove it from addition of operations on the current thread
<ReturnType> void	operationCompleted(xal.tools.dispatch.DispatchOperation<ReturnType> operation) Event indicating that an operation in this group has completed
void	waitForCompletion() wait indefinitely for all operations to complete
void	waitForCompletionWithTimeout(long timeout) wait at most the timeout for all operations to complete

Methods inherited from class java.lang.Object

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

Constructor Detail

DispatchGroup

public DispatchGroup()

Constructor

Method Detail

getCurrentGroups

protected static java.util.Set<DispatchGroup> getCurrentGroups()

Get the set of current groups

enter

public void enter()

Enter this group for addition of operations on the current thread

leave

public void leave()

Leave this group to remove it from addition of operations on the current thread

await

public void await()

synonym for waitForCompletion()

waitForCompletion

public void waitForCompletion()

wait indefinitely for all operations to complete

await

public void await(long timeout)

synonym for waitForCompletionWithTimeout( timeout )

waitForCompletionWithTimeout

public void waitForCompletionWithTimeout(long timeout)

wait at most the timeout for all operations to complete

Parameters:

timeout - the maximum timeout in milliseconds to wait

addOperationToThisGroupAndCurrentGroups

public <ReturnType> void addOperationToThisGroupAndCurrentGroups(xal.tools.dispatch.DispatchOperation<ReturnType> operation)

add the operation to this group and the current groups without double counting this group

addOperationToCurrentGroups

public static <ReturnType> void addOperationToCurrentGroups(xal.tools.dispatch.DispatchOperation<ReturnType> operation)

add the operation to the current groups

addOperationToGroups

public static <ReturnType> void addOperationToGroups(xal.tools.dispatch.DispatchOperation<ReturnType> operation,
                                                     java.util.Set<DispatchGroup> groups)

add the operation to the specified groups

addOperation

public <ReturnType> void addOperation(xal.tools.dispatch.DispatchOperation<ReturnType> operation)

add an operation to this group

operationCompleted

public <ReturnType> void operationCompleted(xal.tools.dispatch.DispatchOperation<ReturnType> operation)

Event indicating that an operation in this group has completed