001/**
002 * Copyright (c) 2011, The University of Southampton and the individual contributors.
003 * All rights reserved.
004 *
005 * Redistribution and use in source and binary forms, with or without modification,
006 * are permitted provided that the following conditions are met:
007 *
008 *   *  Redistributions of source code must retain the above copyright notice,
009 *      this list of conditions and the following disclaimer.
010 *
011 *   *  Redistributions in binary form must reproduce the above copyright notice,
012 *      this list of conditions and the following disclaimer in the documentation
013 *      and/or other materials provided with the distribution.
014 *
015 *   *  Neither the name of the University of Southampton nor the names of its
016 *      contributors may be used to endorse or promote products derived from this
017 *      software without specific prior written permission.
018 *
019 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
020 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
021 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
022 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
023 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
024 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
025 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
026 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
027 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
028 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
029 */
030/**
031 * 
032 */
033package org.openimaj.demos;
034
035import java.lang.annotation.Retention;
036import java.lang.annotation.RetentionPolicy;
037
038/**
039 *      An annotation for types that are implementing an OpenIMAJ demo. Use this
040 *      annotation to specify that your class should be considered an OpenIMAJ
041 *      demo. The {@link Demos} GUI will look for types that are annotated with
042 *      this annotation for presenting to the user as a self-contained demo.
043 *      <p>
044 *      It is quite important that any classes that are annotated with this type
045 *      are fully self-contained and do not have hard-coded, local filenames. They
046 *      should use resources and the resources should be included.
047 * 
048 *      @author David Dupplaw (dpd@ecs.soton.ac.uk)
049 *      @created 2 November 2011
050 */
051@Retention(RetentionPolicy.RUNTIME)
052public @interface Demo 
053{
054        /** The title of the demo. Should be short. No more than 30 characters */
055        String   title();
056
057        /** Name of the author of the demo */
058        String   author();
059        
060        /** A description of the demo. As long as you like. */
061        String   description();
062        
063        /** Keywords associated with the demo. */
064        String[] keywords();
065        
066        /** The resource URI of an icon to represent the demo [optional] */
067        String   icon() default "/defaults/demo.png";
068        
069        /** The resource URI of a screenshot of the demo [optional] */
070        String   screenshot() default "/defaults/screenshot.png";
071        
072        /** Any arguments that need to be passed to the demo */
073        String[] arguments() default {};
074        
075        /** Any JVM arguments that need to be passed to the demo */
076        String[] vmArguments() default {};
077}