org.cyclopsgroup.jcli.annotation.Argument Maven / Gradle / Ivy

Go to download

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

Annotation based command line arguments parser

There is a newer version: 1.0.1

package org.cyclopsgroup.jcli.annotation;

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

/**
 * This annotation marks a property as non-option argument or arguments. Type of this property can be array, List or
 * single value.
 *
 * @author Jiaqi Guo
 */
@Documented
@Target( { ElementType.METHOD, ElementType.FIELD } )
@Retention( RetentionPolicy.RUNTIME )
public @interface Argument
{
    /**
     * @return String description of argument which will be displayed in usage
     */
    String description() default "";

    /**
     * @return Name of argument displayed in usage
     */
    String displayName() default "arg";
}