1/*
2 * Copyright (c) 1997, 2016, 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.
8 *
9 * This code is distributed in the hope that it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
12 * version 2 for more details (a copy is included in the LICENSE file that
13 * accompanied this code).
14 *
15 * You should have received a copy of the GNU General Public License version
16 * 2 along with this work; if not, write to the Free Software Foundation,
17 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
18 *
19 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
20 * or visit www.oracle.com if you need additional information or have any
21 * questions.
22 */
23package org.netbeans.jemmy;
24
25/**
26 *
27 * Defines an action to be executed by {@code ActionProducer} instance.
28 *
29 * @see org.netbeans.jemmy.ActionProducer
30 *
31 * @author Alexandre Iline (alexandre.iline@oracle.com)
32 */
33public interface Action<R, P> {
34
35    /**
36     * Executes this action.
37     *
38     * @param obj action argument. This argument might be the method parameter
39     * in an invocation of {@code ActionProducer.produceAction(Object)}.
40     * @return action result.
41     */
42    public R launch(P obj);
43
44    /**
45     * Returns the description value.
46     *
47     * @return Action description.
48     */
49    public String getDescription();
50}
51