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
25import java.awt.Component;
26
27/**
28 *
29 * This interface should be implemented to define the criteria used to search
30 * for a component.
31 *
32 * @see org.netbeans.jemmy.ComponentSearcher
33 * @see org.netbeans.jemmy.WindowWaiter
34 *
35 * @author Alexandre Iline (alexandre.iline@oracle.com)
36 */
37public interface ComponentChooser {
38
39    /**
40     * Check if the component argument meets the search criteria.
41     *
42     * @param comp Component to check.
43     * @return {@code true} when the component conforms to the search
44     * criteria; {@code false} otherwise.
45     */
46    public boolean checkComponent(Component comp);
47
48    /**
49     * Returns searched component description.
50     *
51     * @return a String representing the description value
52     */
53    public String getDescription();
54}
55