001package eu.cqse.check.framework.core.option;
002
003import java.lang.annotation.Documented;
004import java.lang.annotation.ElementType;
005import java.lang.annotation.Retention;
006import java.lang.annotation.RetentionPolicy;
007import java.lang.annotation.Target;
008
009/**
010 * Annotation that is used to mark attributes of custom checks as options.
011 */
012@Documented
013@Retention(RetentionPolicy.RUNTIME)
014@Target(ElementType.FIELD)
015public @interface CheckOption {
016
017        /** The option's name. */
018        String name();
019
020        /** The option's description. */
021        String description();
022
023        /**
024         * Whether this option is multiline text (rendering advice for configuration
025         * UI).
026         */
027        boolean multilineText() default false;
028}