xerial.lens.cui.command Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of xerial-lens Show documentation

Lens for mapping between objects and structured data (XML, JSON, Silk, etc.)

There is a newer version: 3.4.0

package xerial.lens.cui;

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

/**
 * Annotation for methods that can be invoked as commands
 *
 * @author leo
 *
 */
@Retention(RetentionPolicy.RUNTIME)
@Target( { ElementType.METHOD })
public @interface command {

    /**
     * Description of the option, used to generate a help message of this
     * command-line options.
     */
    String description() default "";

    /**
     * One-line usage note e.g. "$ command name (argument)"
     * @return
     */
    String usage() default "";

    /**
     * Detailed help message of the command. For writing multi-line help messages,
     * "|" can be used as prefixes of lines.
     * @return
     */
    String detailedHelp() default "";


}