WindowJob.java revision 13978:1993af50385d
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.util;
24
25import java.awt.Component;
26
27import org.netbeans.jemmy.Action;
28import org.netbeans.jemmy.ComponentChooser;
29
30/**
31 *
32 * Supposed to be used to perform some periodical job.
33 *
34 * @see WindowManager
35 *
36 * @author Alexandre Iline (alexandre.iline@oracle.com)
37 */
38public interface WindowJob<R, P> extends ComponentChooser, Action<R, P> {
39
40    /**
41     * Perform necessary actions.
42     */
43    @Override
44    public R launch(P obj);
45
46    /**
47     * Checks if window is what we want to do something with.
48     */
49    @Override
50    public boolean checkComponent(Component comp);
51
52    /**
53     * Job description.
54     */
55    @Override
56    public String getDescription();
57}
58