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 public static final String ACTION_EXECUTOR_PROPERTY = "action.executor"; 40 41 /** 42 * Schedules to execute an action and waits for it to finish. 43 * @param env Environment. 44 * @param dispatch if true the action is executed on UI system dispatch 45 * thread. This is usually necessary to invoke methods of the UI to get 46 * the correct state or to update it. 47 * @param action Action to execute. 48 * @param parameters Parameters to pass to 49 * {@linkplain Action#run(java.lang.Object[]) action.run()} method. 50 */ 51 public void execute(Environment env, boolean dispatch, Action action, Object... parameters); 52 53 /** 54 * Schedules to execute an action and exits immediately. Used to be called 55 * DoSomethingNoBlock operations in jemmy2. 56 * @param env Environment. 57 * @param dispatch if true the action is executed on UI system dispatch 58 * thread. This is usually necessary to invoke methods of the UI to get 59 * the correct state or to update it. 60 * @param action Action to execute. 61 * @param parameters Parameters to pass to 62 * {@linkplain Action#run(java.lang.Object[]) action.run()} method. 63 */ 64 public void executeDetached(Environment env, boolean dispatch, Action action, Object... parameters); 65 66 /** 67 * Checks whether the current thread is already performing an action. 68 * @return true if the current thread is already performing an action. 69 */ 70 public boolean isInAction(); 71 72 /** 73 * Waits for no activities to be going on. Implementation may be different 74 * for different mechanisms. 75 * @param waitTime maximum time for waiting. 76 * @see AbstractExecutor#isQuiet() 77 */ 78 public void waitQuiet(Timeout waitTime); 79 }