Annotation Type CommandDescription
-
@Documented @Retention(RUNTIME) @Target(TYPE) public @interface CommandDescriptionThis is for annotating classes which extendAbstractCommand- Since:
- 1.0.0
- See Also:
AbstractCommand
-
-
Required Element Summary
Required Elements Modifier and Type Required Element Description java.lang.StringnameThis represents the name of theAbstractCommandwhich is annotated with thisCommandDescriptionjava.lang.String[]triggersThis represents an array of Strings which could trigger theAbstractCommandwhich is annotated with thisCommandDescriptionhas.
-
Optional Element Summary
Optional Elements Modifier and Type Optional Element Description CommandAttribute[]attributesThis represents an Array ofCommandAttributethat theAbstractCommandwhich is annotated with thisCommandDescriptionhas.java.lang.StringdescriptionThis represents the description of theAbstractCommandwhich is annotated with thisCommandDescriptionhas.
-
-
-
Element Detail
-
name
java.lang.String name
This represents the name of theAbstractCommandwhich is annotated with thisCommandDescription- Returns:
- The name of the command, should never be
null. - Since:
- 1.0.0
-
-
-
triggers
java.lang.String[] triggers
This represents an array of Strings which could trigger theAbstractCommandwhich is annotated with thisCommandDescriptionhas.- Returns:
- An Array of Strings which could trigger the command.
- Since:
- 1.0.0
-
-
-
description
java.lang.String description
This represents the description of theAbstractCommandwhich is annotated with thisCommandDescriptionhas.- Returns:
- The description of the command, default as an empty string.
- Since:
- 1.0.6
- Default:
- ""
-
-
-
attributes
CommandAttribute[] attributes
This represents an Array ofCommandAttributethat theAbstractCommandwhich is annotated with thisCommandDescriptionhas.- Returns:
- An array of
CommandAttributes, will return an empty array if no attributes are used. - Since:
- 1.0.0
- Default:
- {}
-
-