org.broadinstitute.barclay.argparser.DeprecatedFeature Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of barclay Show documentation

Development on Barclay command line parsing and documentation utilities

The newest version!

package org.broadinstitute.barclay.argparser;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Inherited;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * Used to mark a feature ({@link Argument} or {@link CommandLineProgramProperties}) as deprecated. Mutually
 * exclusive with {@link BetaFeature} and {@link ExperimentalFeature}.
 */
@Target({ElementType.TYPE,ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
public @interface DeprecatedFeature {

    /**
     * @return the deprecation detail string associated with this command-line argument.
     */
    String detail() default "This feature is deprecated and will be removed in a future release.";
}