org.tudalgo.algoutils.student.annotation.StudentImplementationRequired Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of algoutils-student Show documentation

Common utilities for the Fachgebiet Algorithmik of TU Darmstadt

The newest version!

package org.tudalgo.algoutils.student.annotation;

import java.lang.annotation.*;

/**
 * This annotation is used to mark classes, functions or fields, that:
 * 
 *     are only present in the solution
 *     are required to be implemented by the student
 *     are not required to be created by the student
 *     were not originally present in the student template
 * 
 */
@Documented
@Inherited
@Retention(RetentionPolicy.CLASS)
@Target({ElementType.METHOD, ElementType.FIELD, ElementType.LOCAL_VARIABLE})
public @interface StudentImplementationRequired {
    /**
     * An optional reason why the annotated element is only present in the solution.
     *
     * @return the reason why the annotated element is only present in the solution
     */
    String value() default "";
}