net.badbird5907.blib.command.Completer Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of bLib-Bukkit Show documentation

There is a newer version: 2.1.11-REL

package net.badbird5907.blib.command;

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

/**
 * Command Framework - Completer 

 * The completer annotation used to designate methods as command completers. All
 * methods should have a single CommandArgs argument and return a String List
 * object
 * 
 * @author minnymin3/Badbird5907/OctoPvP Dev team
 * 
 */
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface Completer {

	/**
	 * The command that this completer completes. If it is a sub command then
	 * its values would be separated by periods. ie. a command that would be a
	 * subcommand of test would be 'test.subcommandname'
	 * 
	 * @return command name
	 */
	String name();

	/**
	 * A list of alternate names that the completer is executed under. See
	 * name() for details on how names work
	 * 
	 * @return aliases
	 */
	String[] aliases() default {};

}