Package org.eclipse.epsilon.common.concurrent

Class SingleConcurrentExecutionStatus

java.lang.Object

org.eclipse.epsilon.common.concurrent.ConcurrentExecutionStatus

org.eclipse.epsilon.common.concurrent.SingleConcurrentExecutionStatus

public class SingleConcurrentExecutionStatus
extends ConcurrentExecutionStatus

Utility class which allows for co-ordinating concurrent execution with waiting semantics for successful and exceptional completion. This class is only suitable for single-condition locking, where there is only one success condition registered at any given time. Multiple conditions can be supported using serial thread confinement or MultiConcurrentExecutionStatus.

Since:

1.6

Author:

Sina Madani

Field Summary

Fields

Modifier and Type	Field	Description
protected long	waitTimeout

Fields inherited from class org.eclipse.epsilon.common.concurrent.ConcurrentExecutionStatus

exception

Constructor Summary

Constructors

Constructor	Description
SingleConcurrentExecutionStatus()

Method Summary

Modifier and Type	Method	Description
void	completeExceptionally(java.lang.Throwable exception)
protected void	completeSuccessfully(java.lang.Object lockObj)
protected void	completeWithResult(java.lang.Object lockObj, java.lang.Object result)
protected java.lang.Object	getResult(java.lang.Object lockObj)
protected boolean	isInProgress(java.lang.Object lockObj)
protected boolean	register(java.lang.Object lockObj)
protected boolean	waitForCompletion(java.lang.Object lockObj, java.util.function.Supplier<java.lang.Boolean> targetState)	Waits until either exceptional or successful completion conditions are signalled.
java.lang.Throwable	waitForExceptionalCompletion()

Methods inherited from class org.eclipse.epsilon.common.concurrent.ConcurrentExecutionStatus

completeExceptionallyBase, completeSuccessfully, completeWithResult, getException, getResult, isInProgress, register, waitForCompletion, waitForCompletion, waitForCompletion

Methods inherited from class java.lang.Object

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

Field Detail

waitTimeout

protected long waitTimeout

Constructor Detail

SingleConcurrentExecutionStatus

public SingleConcurrentExecutionStatus()

Method Detail

getResult

protected final java.lang.Object getResult(java.lang.Object lockObj)

Specified by:

getResult in class ConcurrentExecutionStatus

register

protected final boolean register(java.lang.Object lockObj)

Specified by:

register in class ConcurrentExecutionStatus

Returns:

true if registration was successful.

isInProgress

protected final boolean isInProgress(java.lang.Object lockObj)

Specified by:

isInProgress in class ConcurrentExecutionStatus

completeSuccessfully

protected final void completeSuccessfully(java.lang.Object lockObj)

Specified by:

completeSuccessfully in class ConcurrentExecutionStatus

completeWithResult

protected final void completeWithResult(java.lang.Object lockObj,
                                        java.lang.Object result)

Specified by:

completeWithResult in class ConcurrentExecutionStatus

completeExceptionally

public final void completeExceptionally(java.lang.Throwable exception)

Specified by:

completeExceptionally in class ConcurrentExecutionStatus

waitForCompletion

protected final boolean waitForCompletion(java.lang.Object lockObj,
                                          java.util.function.Supplier<java.lang.Boolean> targetState)

Waits until either exceptional or successful completion conditions are signalled.

Specified by:

waitForCompletion in class ConcurrentExecutionStatus

Returns:

Whether the completion was successful (true) or exceptional (false).

waitForExceptionalCompletion

public java.lang.Throwable waitForExceptionalCompletion()

Overrides:

waitForExceptionalCompletion in class ConcurrentExecutionStatus