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 package org.jemmy.control;
  26 
  27 import java.lang.annotation.*;
  28 import org.jemmy.interfaces.TypeControlInterface;
  29 
  30 /**
  31  * This annotation should be used to annotate methods which turn a wrap
  32  * into a control interface. It is, then, used in <code>Wrap.as(*)</code> and
  33  * <code>Wrap.is(*)</code> methods and in <code>*Dock.as*()</code> methods.
  34  * @see Wrap#as(java.lang.Class)
  35  * @see Wrap#as(java.lang.Class, java.lang.Class)
  36  * @see Wrap#is(java.lang.Class)
  37  * @see Wrap#is(java.lang.Class, java.lang.Class)
  38  * @author shura
  39  */
  40 @Retention(RetentionPolicy.RUNTIME)
  41 @Target(ElementType.METHOD)
  42 @Documented
  43 public @interface As {
  44     /**
  45      * This should point out what is the encapsulated type for
  46      * <code>TypeControlInterface</code>
  47      * @see TypeControlInterface
  48      * @return todo document
  49      */
  50     Class value() default Void.class;
  51 }