org.jemmy.action

Class AbstractExecutor

java.lang.Object

org.jemmy.action.AbstractExecutor

All Implemented Interfaces:

ActionExecutor

Direct Known Subclasses:

DefaultExecutor

public abstract class AbstractExecutor
extends Object
implements ActionExecutor

Author:

shura

Field Summary

Fields

Modifier and Type	Field and Description
static Timeout	MAX_ACTION_TIME Default timeout for action run() method to be completed.
static String	NON_QUEUE_ACTION_OUTPUT Indentifies output which would be used to print information for all actions executed not on event queue.
static String	QUEUE_ACTION_OUTPUT Indentifies output which would be used to print information for all actions executed on event queue.

Fields inherited from interface org.jemmy.action.ActionExecutor

ACTION_EXECUTOR_PROPERTY

Constructor Summary

Constructors

Constructor and Description
AbstractExecutor()

Method Summary

Modifier and Type	Method and Description
protected int	actionsInQueue()
void	execute(Environment env, boolean dispatch, Action action, Object... parameters) Schedules to execute an action and waits for it to finish.
void	executeDetached(Environment env, boolean dispatch, Action action, Object... parameters) Schedules to execute an action and exits immediately.
abstract void	executeQueue(Environment env, Action action, Object... parameters) Schedules to execute an action through the UI system's dispatch thread and waits for the action to be completed.
abstract void	executeQueueDetached(Environment env, Action action, Object... parameters) Schedules to execute an action through the UI system's dispatch thread and exits immediately.
boolean	isInAction() Checks whether the current thread is already performing an action.
abstract boolean	isOnQueue() Checks whether this is invoked from the UI system event queue.
protected abstract boolean	isQuiet() Tells whether the UI is quiet which usually means that all scheduled actions are dispatched and the queue is empty.
void	waitQuiet(Timeout waitTime) Waits for UI to became quiet which is determined using isQuiet() method.

Methods inherited from class java.lang.Object

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

Field Detail

MAX_ACTION_TIME

public static final Timeout MAX_ACTION_TIME

Default timeout for action run() method to be completed.

NON_QUEUE_ACTION_OUTPUT

public static final String NON_QUEUE_ACTION_OUTPUT

Indentifies output which would be used to print information for all actions executed not on event queue.

See Also:

execute(org.jemmy.env.Environment, boolean, org.jemmy.action.Action, java.lang.Object[]), executeDetached(org.jemmy.env.Environment, boolean, org.jemmy.action.Action, java.lang.Object[]), Environment.getOutput(java.lang.String), Constant Field Values

QUEUE_ACTION_OUTPUT

public static final String QUEUE_ACTION_OUTPUT

Indentifies output which would be used to print information for all actions executed on event queue.

See Also:

execute(org.jemmy.env.Environment, boolean, org.jemmy.action.Action, java.lang.Object[]), executeDetached(org.jemmy.env.Environment, boolean, org.jemmy.action.Action, java.lang.Object[]), Environment.getOutput(java.lang.String), Constant Field Values

Constructor Detail

AbstractExecutor

public AbstractExecutor()

Method Detail

actionsInQueue

protected int actionsInQueue()

execute

public final void execute(Environment env,
                          boolean dispatch,
                          Action action,
                          Object... parameters)

Schedules to execute an action and waits for it to finish. Prints out what action is executed into output specified by either NON_QUEUE_ACTION_OUTPUT or QUEUE_ACTION_OUTPUT depending whether the action is called on queue or not. No output provided for nested actions - only the top level ones are printed.

Specified by:

execute in interface ActionExecutor

Parameters:

env - Environment.

dispatch - if true the action is executed on UI system dispatch thread. This is usually necessary to invoke methods of the UI to get the correct state or to update it.

action - Action to execute.

parameters - Parameters to pass to action.run() method.

See Also:

TestOut.getOutput()

executeDetached

public final void executeDetached(Environment env,
                                  boolean dispatch,
                                  Action action,
                                  Object... parameters)

Schedules to execute an action and exits immediately. Used to be called DoSomethingNoBlock operations in jemmy2. Prints out what action is executed into output specified by either NON_QUEUE_ACTION_OUTPUT or QUEUE_ACTION_OUTPUT depending whether the action is called on queue or not. No output provided for nested actions - only the top level ones are printed.

Specified by:

executeDetached in interface ActionExecutor

Parameters:

env - Environment.

dispatch - if true the action is executed on UI system dispatch thread. This is usually necessary to invoke methods of the UI to get the correct state or to update it.

action - Action to execute.

parameters - Parameters to pass to action.run() method.

See Also:

TestOut.getOutput()

isInAction

public final boolean isInAction()

Checks whether the current thread is already performing an action.

Specified by:

isInAction in interface ActionExecutor

Returns:

true if the current thread is already performing an action.

executeQueue

public abstract void executeQueue(Environment env,
                                  Action action,
                                  Object... parameters)

Schedules to execute an action through the UI system's dispatch thread and waits for the action to be completed. This method is called from execute() method when it is invoked with dispatch argument set to true.

Parameters:

env - Environment.

action - action to execute.

parameters - parameters to pass to action.run() method.

executeQueueDetached

public abstract void executeQueueDetached(Environment env,
                                          Action action,
                                          Object... parameters)

Schedules to execute an action through the UI system's dispatch thread and exits immediately. This method is called from executeDetached() method when it is invoked with dispatch argument set to true.

Parameters:

env - Environment.

action - action to execute.

parameters - parameters to pass to action.run() method.

isOnQueue

public abstract boolean isOnQueue()

Checks whether this is invoked from the UI system event queue.

Returns:

true if invoked from the UI system event queue.

waitQuiet

public void waitQuiet(Timeout waitTime)

Waits for UI to became quiet which is determined using isQuiet() method.

Specified by:

waitQuiet in interface ActionExecutor

Parameters:

waitTime - maximum time for waiting.

See Also:

isQuiet()

isQuiet

protected abstract boolean isQuiet()

Tells whether the UI is quiet which usually means that all scheduled actions are dispatched and the queue is empty.

Returns:

true if the UI is quiet.

See Also:

waitQuiet(org.jemmy.env.Timeout)