1 /* 2 * Copyright (c) 2007, 2017 Oracle and/or its affiliates. All rights reserved. 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4 * 5 * This code is free software; you can redistribute it and/or modify it 6 * under the terms of the GNU General Public License version 2 only, as 7 * published by the Free Software Foundation. Oracle designates this 8 * particular file as subject to the "Classpath" exception as provided 9 * by Oracle in the LICENSE file that accompanied this code. 10 * 11 * This code is distributed in the hope that it will be useful, but WITHOUT 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 14 * version 2 for more details (a copy is included in the LICENSE file that 15 * accompanied this code). 16 * 17 * You should have received a copy of the GNU General Public License version 18 * 2 along with this work; if not, write to the Free Software Foundation, 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 20 * 21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA 22 * or visit www.oracle.com if you need additional information or have any 23 * questions. 24 */ 25 26 package org.jemmy.action; 27 28 29 import org.jemmy.env.Environment; 30 import org.jemmy.env.Timeout; 31 32 33 /** 34 * Interface to execute user's action <b>at appropriate moment</b>. 35 * @author shura 36 */ 37 public interface ActionExecutor { 38 39 /** 40 * 41 */ 42 public static final String ACTION_EXECUTOR_PROPERTY = "action.executor"; 43 44 /** 45 * Schedules to execute an action and waits for it to finish. 46 * @param env Environment. 47 * @param dispatch if true the action is executed on UI system dispatch 48 * thread. This is usually necessary to invoke methods of the UI to get 49 * the correct state or to update it. 50 * @param action Action to execute. 51 * @param parameters Parameters to pass to 52 * {@linkplain Action#run(java.lang.Object[]) action.run()} method. 53 */ 54 public void execute(Environment env, boolean dispatch, Action action, Object... parameters); 55 56 /** 57 * Schedules to execute an action and exits immediately. Used to be called 58 * DoSomethingNoBlock operations in jemmy2. 59 * @param env Environment. 60 * @param dispatch if true the action is executed on UI system dispatch 61 * thread. This is usually necessary to invoke methods of the UI to get 62 * the correct state or to update it. 63 * @param action Action to execute. 64 * @param parameters Parameters to pass to 65 * {@linkplain Action#run(java.lang.Object[]) action.run()} method. 66 */ 67 public void executeDetached(Environment env, boolean dispatch, Action action, Object... parameters); 68 69 /** 70 * Checks whether the current thread is already performing an action. 71 * @return true if the current thread is already performing an action. 72 * @see AbstractExecutor#isDispatchThread() 73 */ 74 public boolean isInAction(); 75 76 /** 77 * Waits for no activities to be going on. Implementation may be different 78 * for different mechanisms. 79 * @param waitTime maximum time for waiting. 80 * @see AbstractExecutor#isQuiet() 81 */ 82 public void waitQuiet(Timeout waitTime); 83 }