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 */
030package org.openimaj.experiment.annotations;
031
032import java.lang.annotation.Documented;
033import java.lang.annotation.ElementType;
034import java.lang.annotation.Retention;
035import java.lang.annotation.RetentionPolicy;
036import java.lang.annotation.Target;
037
038import org.openimaj.experiment.ExperimentContext;
039import org.openimaj.experiment.ExperimentRunner;
040import org.openimaj.experiment.RunnableExperiment;
041
042/**
043 * Annotation for describing an instance of a {@link RunnableExperiment}. The
044 * information provided by the annotation is used to fill in the
045 * {@link ExperimentContext} when the experiment is run with a
046 * {@link ExperimentRunner}.
047 *
048 * @author Jonathon Hare (jsh2@ecs.soton.ac.uk)
049 *
050 */
051@Documented
052@Retention(value = RetentionPolicy.RUNTIME)
053@Target(value = ElementType.TYPE)
054public @interface Experiment {
055        /**
056         * @return the authors of the experiment
057         */
058        String author();
059
060        /**
061         * @return a description of the experiment
062         */
063        String description();
064
065        /**
066         * @return the data the experiment was created
067         */
068        String dateCreated();
069}