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.dock;
27
28 import java.lang.annotation.Documented;
29 import java.lang.annotation.ElementType;
30 import java.lang.annotation.Target;
31 import org.jemmy.control.Wrap;
32
33 /**
34 * This should be used on classes - inheritors of <code>Wrap</code> class to give
35 * annotation processor some information.
36 * @see Wrap
37 * @author shura
38 */
39 @Target(ElementType.TYPE)
40 @Documented
41 public @interface DockInfo {
42 /**
43 * Desired name of the dock class, should one be generated.
44 * Usually empty ("", as nulls are not allowed) in which case the calculated value
45 * is taken whatever logic annotation processor decides to use.
46 */
47 String name() default "";
48
49 /**
50 * Should there be extra constructors which take another lookup criteria - a class
51 * of a desired control? That class must be a subtype of the one wrapped by the wrap
52 * class annotated with this annotation.
53 */
54 boolean generateSubtypeLookups() default false;
55
56 /**
57 * Should generated <code>wrap()</code> method return this class or
58 * <code>Wrap<? extends ...></code> and also should there be a constructor with
59 * one parameter - the wrap.
60 */
61 boolean anonymous() default false;
62
63 /**
64 * Should the lookup constructors have <code>LookupCriteria<Type>...</code>
65 * parameter or the <code>LookupCriteria<Type></code> parameter.
66 */
67 boolean multipleCriteria() default true;
68 }