org.kohsuke.args4j.Argument Maven / Gradle / Ivy

Go to download
package org.kohsuke.args4j;

import java.lang.annotation.Retention;
import java.lang.annotation.Target;

import org.kohsuke.args4j.spi.OptionHandler;

import static java.lang.annotation.RetentionPolicy.RUNTIME;
import static java.lang.annotation.ElementType.FIELD;
import static java.lang.annotation.ElementType.METHOD;
import static java.lang.annotation.ElementType.PARAMETER;

/**
 * Argument of the command line.
 *
 * This works mostly like {@link Option} except the following differences.
 *
 * 
 *  Arguments have an index about their relative position on the command line.
 * 
 * 
 * @author Kohsuke Kawaguchi
 * @author Mark Sinke
 */
@Retention(RUNTIME)
@Target({FIELD,METHOD,PARAMETER})
public @interface Argument {
    /**
     * See {@link Option#usage()}.
     */
    String usage() default "";
    /**
     * See {@link Option#metaVar()}.
     */
    String metaVar() default "";
    /**
     * See {@link Option#required()}.
     */
    boolean required() default false;

    /**
     * See {@link Option#hidden()}.
     */
    boolean hidden() default false;

    /**
     * See {@link Option#handler()}.
     */
    Class handler() default OptionHandler.class;

    /**
     * Position of the argument.
     *
     * 
     * If you define multiple single value properties to bind to arguments,
     * they should have {@code index=0, index=1, index=2}, ... and so on.
     *
     * 
     * Multi value properties bound to arguments must be always the last entry.
     */
    int index() default 0;

    /**
     *
     */
    boolean multiValued() default false;
}