1 /**
2 * Copyright (c) 2011, The University of Southampton and the individual contributors.
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without modification,
6 * are permitted provided that the following conditions are met:
7 *
8 * * Redistributions of source code must retain the above copyright notice,
9 * this list of conditions and the following disclaimer.
10 *
11 * * Redistributions in binary form must reproduce the above copyright notice,
12 * this list of conditions and the following disclaimer in the documentation
13 * and/or other materials provided with the distribution.
14 *
15 * * Neither the name of the University of Southampton nor the names of its
16 * contributors may be used to endorse or promote products derived from this
17 * software without specific prior written permission.
18 *
19 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
21 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
22 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
23 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
24 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
25 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
26 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
28 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 */
30 /**
31 *
32 */
33 package org.openimaj.demos;
34
35 import java.lang.annotation.Retention;
36 import java.lang.annotation.RetentionPolicy;
37
38 /**
39 * An annotation for types that are implementing an OpenIMAJ demo. Use this
40 * annotation to specify that your class should be considered an OpenIMAJ
41 * demo. The {@link Demos} GUI will look for types that are annotated with
42 * this annotation for presenting to the user as a self-contained demo.
43 * <p>
44 * It is quite important that any classes that are annotated with this type
45 * are fully self-contained and do not have hard-coded, local filenames. They
46 * should use resources and the resources should be included.
47 *
48 * @author David Dupplaw (dpd@ecs.soton.ac.uk)
49 * @created 2 November 2011
50 */
51 @Retention(RetentionPolicy.RUNTIME)
52 public @interface Demo
53 {
54 /** The title of the demo. Should be short. No more than 30 characters */
55 String title();
56
57 /** Name of the author of the demo */
58 String author();
59
60 /** A description of the demo. As long as you like. */
61 String description();
62
63 /** Keywords associated with the demo. */
64 String[] keywords();
65
66 /** The resource URI of an icon to represent the demo [optional] */
67 String icon() default "/defaults/demo.png";
68
69 /** The resource URI of a screenshot of the demo [optional] */
70 String screenshot() default "/defaults/screenshot.png";
71
72 /** Any arguments that need to be passed to the demo */
73 String[] arguments() default {};
74
75 /** Any JVM arguments that need to be passed to the demo */
76 String[] vmArguments() default {};
77 }