WindowJob.java

/*
 * Copyright (c) 1997, 2016, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */
package org.netbeans.jemmy.util;

import java.awt.Component;

import org.netbeans.jemmy.Action;
import org.netbeans.jemmy.ComponentChooser;

/**
 *
 * Supposed to be used to perform some periodical job.
 *
 * @see WindowManager
 *
 * @author Alexandre Iline (alexandre.iline@oracle.com)
 */
public interface WindowJob<R, P> extends ComponentChooser, Action<R, P> {

    /**
     * Perform necessary actions.
     */
    @Override
    public R launch(P obj);

    /**
     * Checks if window is what we want to do something with.
     */
    @Override
    public boolean checkComponent(Component comp);

    /**
     * Job description.
     */
    @Override
    public String getDescription();
}