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.interfaces;
  27 
  28 import org.jemmy.lookup.Lookup;
  29 import org.jemmy.lookup.LookupCriteria;
  30 
  31 /**
  32  * Represents a container for UI controls.
  33  * @param <T> type of the control.
  34  * @author shura
  35  */
  36 public interface Parent<T> extends TypeControlInterface<T> {
  37     /**
  38      * Searcher the hierarchy for objects extending <code>ST</code> which fit
  39      * the criteria.
  40      * @see Lookup
  41      * @see LookupCriteria
  42      * @param <ST> todo document
  43      * @param controlClass todo document
  44      * @param criteria todo document
  45      * @return an instance of Lookup, which holds found controls.
  46      */
  47     public <ST extends T> Lookup<ST> lookup(Class<ST> controlClass, LookupCriteria<ST> criteria);
  48     /**
  49      * Same as <code>lookup(controlClass, new Any())</code>
  50      * @see #lookup(java.lang.Class, org.jemmy.lookup.LookupCriteria)
  51      * @param <ST> todo document
  52      * @param controlClass todo document
  53      * @return an instance of Lookup, which holds found controls.
  54      */
  55     public <ST extends T> Lookup<ST> lookup(Class<ST> controlClass);
  56     /**
  57      * Searcher the hierarchy for objects extending <code>T</code> which fit
  58      * the criteria.
  59      * @see Lookup
  60      * @see LookupCriteria
  61      * @param criteria todo document
  62      * @return an instance of Lookup, which holds found controls.
  63      */
  64     public Lookup<T> lookup(LookupCriteria<T> criteria);
  65     /**
  66      * Same as <code>lookup(new Any())</code>
  67      * @see #lookup(org.jemmy.lookup.LookupCriteria)
  68      * @return an instance of Lookup, which holds found controls.
  69      */
  70     public Lookup<T> lookup();
  71 }