package com.github.ompc.greys.core.command.annotation;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* 指令位置参数
*/
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
public @interface IndexArg {
/**
* 参数在命令中的位置
*
* @return 参数在命令中的位置
*/
int index();
/**
* 参数名称
*
* @return 参数名称
*/
String name();
/**
* 参数摘要
*
* @return 参数摘要
*/
String summary() default "";
/**
* 更详细的参数注释
*
* @return 更详细的参数注释
*/
String description() default "";
/**
* 是否必填
*
* @return 是否必填
*/
boolean isRequired() default true;
}