|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.ibm.retail.AEF.thread.ConditionLock
An synchronization mechanism which can use an external lock.
Field Summary | |
---|---|
protected com.ibm.retail.AEF.action.AEFAction |
action
|
protected com.ibm.retail.AEF.thread.MutexLock |
lock
|
protected com.ibm.retail.AEF.util.AEFMessage |
msg
|
protected java.lang.String |
name
|
protected int |
returnIndex
|
protected com.ibm.retail.AEF.session.AEFSession |
session
|
protected int |
timeout
|
protected com.ibm.retail.si.util.AEFException |
unblockException
|
protected java.lang.RuntimeException |
unblockRuntimeException
|
Constructor Summary | |
---|---|
ConditionLock()
Constructs a ConditionLock with an internal lock object. |
Method Summary | |
---|---|
(package private) static java.lang.String |
copyright()
|
com.ibm.retail.AEF.thread.MutexLock |
getLock()
Gets the lock object for this condition variable. |
java.lang.Thread |
getLockOwner()
Gets the thread which owns the lock object for this condition variable. |
void |
notify(com.ibm.retail.si.util.AEFException e)
Unblock a thread waiting on this condition variable by throwing an exception on the blocked thread. |
void |
notify(int index)
Notify any threads waiting on this condition variable to execute. |
void |
notify(java.lang.RuntimeException e)
Unblock a thread waiting on this condition variable by throwing an exception on the blocked thread. |
int |
performActionAndWait(java.lang.String name,
com.ibm.retail.AEF.action.AEFAction action,
com.ibm.retail.AEF.automation.Condition[] conditions,
com.ibm.retail.AEF.automation.Condition[] errorConditions,
int timeout)
Blocks the calling thread on the condition variable or a timeout |
int |
performActionAndWait(java.lang.String name,
com.ibm.retail.AEF.action.AEFAction action,
com.ibm.retail.AEF.automation.Condition[] conditions,
com.ibm.retail.AEF.automation.Condition errorCondition,
int timeout)
Blocks the calling thread on the condition variable or a timeout |
int |
performActionAndWait(java.lang.String name,
com.ibm.retail.AEF.action.AEFAction action,
com.ibm.retail.AEF.automation.Condition[] conditions,
int timeout)
Blocks the calling thread on the condition variable or a timeout |
int |
performActionAndWait(java.lang.String name,
com.ibm.retail.AEF.action.AEFAction action,
com.ibm.retail.AEF.automation.Condition condition,
int timeout)
Blocks the calling thread on the condition variable or a timeout |
int |
wait(java.lang.String name,
com.ibm.retail.AEF.automation.Condition[] conditions,
com.ibm.retail.AEF.automation.Condition[] errorConditions,
int timeout)
Blocks the calling thread on the condition variable or a timeout |
int |
wait(java.lang.String name,
com.ibm.retail.AEF.automation.Condition[] conditions,
com.ibm.retail.AEF.automation.Condition[] errorConditions,
int timeout,
boolean immediateEval)
Blocks the calling thread on the condition variable or a timeout |
int |
wait(java.lang.String name,
com.ibm.retail.AEF.automation.Condition[] conditions,
com.ibm.retail.AEF.automation.Condition errorCondition,
int timeout)
Blocks the calling thread on the condition variable or a timeout |
int |
wait(java.lang.String name,
com.ibm.retail.AEF.automation.Condition[] conditions,
com.ibm.retail.AEF.automation.Condition errorCondition,
int timeout,
boolean immediateEval)
Blocks the calling thread on the condition variable or a timeout |
int |
wait(java.lang.String name,
com.ibm.retail.AEF.automation.Condition[] conditions,
int timeout)
Blocks the calling thread on the condition variable or a timeout |
int |
wait(java.lang.String name,
com.ibm.retail.AEF.automation.Condition[] conditions,
int timeout,
boolean immediateEval)
Blocks the calling thread on the condition variable or a timeout |
int |
wait(java.lang.String name,
com.ibm.retail.AEF.automation.Condition condition,
int timeout)
Blocks the calling thread on the condition variable or a timeout. |
int |
wait(java.lang.String name,
com.ibm.retail.AEF.automation.Condition condition,
int timeout,
boolean immediateEval)
Blocks the calling thread on the condition variable or a timeout |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
protected com.ibm.retail.AEF.thread.MutexLock lock
protected com.ibm.retail.AEF.action.AEFAction action
protected int timeout
protected com.ibm.retail.si.util.AEFException unblockException
protected java.lang.RuntimeException unblockRuntimeException
protected int returnIndex
protected java.lang.String name
protected com.ibm.retail.AEF.util.AEFMessage msg
protected com.ibm.retail.AEF.session.AEFSession session
Constructor Detail |
public ConditionLock()
Method Detail |
static java.lang.String copyright()
public int performActionAndWait(java.lang.String name, com.ibm.retail.AEF.action.AEFAction action, com.ibm.retail.AEF.automation.Condition condition, int timeout) throws AEFException
name
- A debug aid. Give a unique name to the condition lock
such as "wait-for-password-state".action
- The action which will be performed which should cause some conditions to change.condition
- The condition to wait for before returning.timeout
- The number of milliseconds to wait for the condition to be true.
AEFException
- public int performActionAndWait(java.lang.String name, com.ibm.retail.AEF.action.AEFAction action, com.ibm.retail.AEF.automation.Condition[] conditions, int timeout) throws AEFException
name
- A debug aid. Give a unique name to the condition lock
such as "wait-for-password-state".action
- The action which will be performed which should cause some conditions to change.conditions
- An array of conditions, one of which must evaluate to true before returning.timeout
- The number of milliseconds to wait for the condition to be true.
AEFException
- public int performActionAndWait(java.lang.String name, com.ibm.retail.AEF.action.AEFAction action, com.ibm.retail.AEF.automation.Condition[] conditions, com.ibm.retail.AEF.automation.Condition errorCondition, int timeout) throws AEFException
name
- A debug aid. Give a unique name to the condition lock
such as "wait-for-password-state".action
- The action which will be performed which should cause some conditions to change.conditions
- An array of conditions, one of which must evaluate to true before returning.errorCondition
- A condition which will cause the calling thread to unblock
if it evaluates to true.timeout
- The number of milliseconds to wait for the condition to be true.
AEFException
- public int performActionAndWait(java.lang.String name, com.ibm.retail.AEF.action.AEFAction action, com.ibm.retail.AEF.automation.Condition[] conditions, com.ibm.retail.AEF.automation.Condition[] errorConditions, int timeout) throws AEFException
name
- A debug aid. Give a unique name to the condition lock
such as "wait-for-password-state".action
- The action which will be performed which should cause some conditions to change.conditions
- An array of conditions, one of which must evaluate to true before returning.errorConditions
- An array of conditions which will cause the calling thread to unblock
if one of the conditions evaluates to true. These conditions are
considered "error" conditions.timeout
- The number of milliseconds to wait for the condition to be true.
AEFException
- public int wait(java.lang.String name, com.ibm.retail.AEF.automation.Condition condition, int timeout) throws AEFException
name
- A debug aid. Give a unique name to the condition lock
such as "wait-for-password-state".condition
- The condition must evaluate to true before returning.timeout
- The number of milliseconds to wait for the condition to be true.
AEFException
- Among the possible AEFException error codes are:
public int wait(java.lang.String name, com.ibm.retail.AEF.automation.Condition condition, int timeout, boolean immediateEval) throws AEFException
name
- A debug aid. Give a unique name to the condition lock
such as "wait-for-password-state".condition
- The condition must evaluate to true before returning.timeout
- The number of milliseconds to wait for the condition to be true.immediateEval
- If true, the conditions are evaluated immediately without first
waiting for a property change.
AEFException
- Among the possible AEFException error codes are:
public int wait(java.lang.String name, com.ibm.retail.AEF.automation.Condition[] conditions, int timeout) throws AEFException
name
- A debug aid. Give a unique name to the condition lock
such as "wait-for-password-state".conditions
- An array of conditions, one of which must evaluate to true before returning.timeout
- The number of milliseconds to wait for the condition to be true.
AEFException
- Among the possible AEFException error codes are:
public int wait(java.lang.String name, com.ibm.retail.AEF.automation.Condition[] conditions, int timeout, boolean immediateEval) throws AEFException
name
- A debug aid. Give a unique name to the condition lock
such as "wait-for-password-state".conditions
- An array of conditions, one of which must evaluate to true before returning.timeout
- The number of milliseconds to wait for the condition to be true.immediateEval
- If true, the conditions are evaluated immediately without first
waiting for a property change.
AEFException
- Among the possible AEFException error codes are:
public int wait(java.lang.String name, com.ibm.retail.AEF.automation.Condition[] conditions, com.ibm.retail.AEF.automation.Condition[] errorConditions, int timeout) throws AEFException
name
- A debug aid. Give a unique name to the condition lock
such as "wait-for-password-state".conditions
- An array of conditions which will cause the calling thread to unblock
if one of the conditions evaluates to true. These conditions are
considered "non-error" conditions.errorConditions
- An array of conditions which will cause the calling thread to unblock
if one of the conditions evaluates to true. These conditions are
considered "error" conditions.timeout
- The number of milliseconds to wait for the condition to be true.
AEFException
- Among the possible AEFException error codes are:
public int wait(java.lang.String name, com.ibm.retail.AEF.automation.Condition[] conditions, com.ibm.retail.AEF.automation.Condition errorCondition, int timeout) throws AEFException
name
- A debug aid. Give a unique name to the condition lock
such as "wait-for-password-state".conditions
- An array of conditions which will cause the calling thread to unblock
if one of the conditions evaluates to true. These conditions are
considered "non-error" conditions.errorCondition
- A condition which will cause the calling thread to unblock
if it evaluates to true. This condition is
considered and "error" condition.timeout
- The number of milliseconds to wait for the condition to be true.
AEFException
- Among the possible AEFException error codes are:
public int wait(java.lang.String name, com.ibm.retail.AEF.automation.Condition[] conditions, com.ibm.retail.AEF.automation.Condition errorCondition, int timeout, boolean immediateEval) throws AEFException
name
- A debug aid. Give a unique name to the condition lock
such as "wait-for-password-state".conditions
- An array of conditions which will cause the calling thread to unblock
if one of the conditions evaluates to true. These conditions are
considered "non-error" conditions.errorCondition
- A condition which will cause the calling thread to unblock
if it evaluates to true. This condition is
considered and "error" condition.timeout
- The number of milliseconds to wait for the condition to be true.immediateEval
- If true, the conditions are evaluated immediately without first
waiting for a property change.
AEFException
- Among the possible AEFException error codes are:
public int wait(java.lang.String name, com.ibm.retail.AEF.automation.Condition[] conditions, com.ibm.retail.AEF.automation.Condition[] errorConditions, int timeout, boolean immediateEval) throws AEFException
name
- A debug aid. Give a unique name to the condition lock
such as "wait-for-password-state".conditions
- An array of conditions which will cause the calling thread to unblock
if one of the conditions evaluates to true. These conditions are
considered "non-error" conditions.errorConditions
- An array of conditions which will cause the calling thread to unblock
if one of the conditions evaluates to true. These conditions are
considered "error" conditions.timeout
- The number of milliseconds to wait for the condition to be true.immediateEval
- If true, the conditions are evaluated immediately without first
waiting for a property change.
AEFException
- Among the possible AEFException error codes are:
public void notify(com.ibm.retail.si.util.AEFException e)
e
- The exception to throw on the blocked thread.public void notify(java.lang.RuntimeException e)
e
- The exception to throw on the blocked thread.public void notify(int index)
public com.ibm.retail.AEF.thread.MutexLock getLock()
public java.lang.Thread getLockOwner()
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |