Package com.burchard36.api.command.annotation

Annotation Interface RegisterCommand

@Retention(RUNTIME)
@Target(TYPE)
public @interface RegisterCommand

Sets specific command settings for a class extending ApiCommand This is required, unless you prefer to use CommandName CommandUsage CommandDescription CommandAliases instead

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
String[]	aliases	Sets the Aliases of a class extending ApiCommand This field is optional, however if a CommandAliases Annotation is set, that annotation will override this value
String	description	Sets the description for the class extending ApiCommand This field is optional, however if a CommandDescription Annotation is set, that annotation will override this value
String	name	Name to set for the class extending ApiCommand This field is absolutely required when using this annotation, unless your are using a CommandName annotation
String	usageMessage	Sets the usage method of a class extending ApiCommand This field is optional, however if a CommandUsage Annotation is set, that annotation will override this value

Element Details

name

@Nonnull
String name

Name to set for the class extending ApiCommand This field is absolutely required when using this annotation, unless your are using a CommandName annotation

Returns:

Nonnull String, and Not empty String

Default:

""

description

@Nonnull
String description

Sets the description for the class extending ApiCommand This field is optional, however if a CommandDescription Annotation is set, that annotation will override this value

Returns:

Any Nonnull string

Default:

""

usageMessage

@Nonnull
String usageMessage

Sets the usage method of a class extending ApiCommand This field is optional, however if a CommandUsage Annotation is set, that annotation will override this value

Returns:

Any Nonnull String

Default:

""

aliases

@Nonnull
String[] aliases

Sets the Aliases of a class extending ApiCommand This field is optional, however if a CommandAliases Annotation is set, that annotation will override this value

Returns:

Nonnull List of String's that have no spaces in them

Default:

{}