Add some JavaDoc to AbstractSWCommand
Alle Prüfungen waren erfolgreich
SteamWarCI Build successful

Dieser Commit ist enthalten in:
yoyosource 2022-07-28 08:54:27 +02:00
Ursprung 21e77c55f0
Commit 1a44aab54a

Datei anzeigen

@ -54,8 +54,14 @@ public abstract class AbstractSWCommand<T> {
protected abstract void createAndSafeCommand(String command, String[] aliases); protected abstract void createAndSafeCommand(String command, String[] aliases);
/**
* This method should unregister the given command.
*/
public abstract void unregister(); public abstract void unregister();
/**
* This method should register the given command.
*/
public abstract void register(); public abstract void register();
protected void commandSystemError(T sender, CommandFrameworkException e) { protected void commandSystemError(T sender, CommandFrameworkException e) {
@ -284,16 +290,31 @@ public abstract class AbstractSWCommand<T> {
return methods; return methods;
} }
/**
* Register a given method as a command entry point.
*/
@Retention(RetentionPolicy.RUNTIME) @Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.METHOD}) @Target({ElementType.METHOD})
@Repeatable(Register.Registeres.class) @Repeatable(Register.Registeres.class)
protected @interface Register { protected @interface Register {
/**
* The sub command on which this command entry point should be registered.
*/
String[] value() default {}; String[] value() default {};
/**
* {@code true} if this is a help command entry.
*/
boolean help() default false; boolean help() default false;
/**
* The description messages for this command entry.
*/
String[] description() default {}; String[] description() default {};
/**
* {@code true} if this command entry should not be tab completed.
*/
boolean noTabComplete() default false; boolean noTabComplete() default false;
@Retention(RetentionPolicy.RUNTIME) @Retention(RetentionPolicy.RUNTIME)