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.ElementType;
036import java.lang.annotation.Retention;
037import java.lang.annotation.RetentionPolicy;
038import java.lang.annotation.Target;
039
040/**
041 *      An annotation for annotating packages that contain demos. This provides a
042 *      means for categorizing demos by placing them in annotated packages.
043 *      <p>
044 *      The annotation itself is set within the package-info.java
045 * 
046 *      @author David Dupplaw (dpd@ecs.soton.ac.uk)
047 *      @created 3 November 2011
048 */
049@Retention(RetentionPolicy.RUNTIME)
050@Target(ElementType.PACKAGE)
051public @interface DemoPackage 
052{
053        /** The display name of the demo package. No more than 30 characters */
054        String   title();
055
056        /** A description of the demo. As long as you like. */
057        String   description();
058        
059        /** Keywords associated with the demo. */
060        String[] keywords();
061        
062        /** The resource URI of an icon to represent the demo [optional] */
063        String   icon() default "/defaults/demo.png";
064}