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.
   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  */
  23 
  24 package org.jemmy.control;
  25 
  26 import java.lang.annotation.Documented;
  27 import java.lang.annotation.ElementType;
  28 import java.lang.annotation.Inherited;
  29 import java.lang.annotation.Retention;
  30 import java.lang.annotation.RetentionPolicy;
  31 import java.lang.annotation.Target;
  32 import org.jemmy.interfaces.ControlInterface;
  33 import org.jemmy.interfaces.TypeControlInterface;
  34 
  35 /**
  36  * To be applied on classes - ancestors of <code>Wrp</code>
  37  * class. 
  38  * @see Wrap
  39  * @author shura
  40  */
  41 @Retention(RetentionPolicy.RUNTIME)
  42 @Target(ElementType.TYPE)
  43 @Inherited
  44 @Documented
  45 public @interface ControlInterfaces {
  46     /**
  47      * List of interfaces supported by this wrap.
  48      * @see ControlInterface
  49      */
  50     Class<? extends ControlInterface>[] value();
  51     /**
  52      * List of encapsulated types for the <code>TypeControlInterface</code> 
  53      * interfaces listed in <code>value</code>.
  54      * Note that this list should be shorter that the <code>value</code> to not
  55      * provide anything for a <code>ControlInterface</code> which is not a  
  56      * <code>TypeControlInterface</code>
  57      * @see TypeControlInterface
  58      */
  59     Class[] encapsulates() default {};
  60     /**
  61      * This provides names for the dock methods which would be generated. If the array
  62      * does not have enough elements, the method would be named as <code>"as" + value[i].getName()</code>.
  63      */
  64     String[] name() default {};
  65 }