Update javadoc & example

Author: mouse0w0

example/team/unstudio/udpl/example/ExampleCommand.java

@@ -1,15 +1,25 @@
 package team.unstudio.udpl.example;
+import java.util.Arrays;
+import java.util.Collections;
+import java.util.List;
+import java.util.stream.Collectors;
+
+import org.bukkit.Material;
 import org.bukkit.entity.Player;
+import org.bukkit.inventory.ItemStack;
 
+import team.unstudio.udpl.command.anno.Alias;
 import team.unstudio.udpl.command.anno.Command;
 import team.unstudio.udpl.command.anno.Optional;
 import team.unstudio.udpl.command.anno.Required;
+import team.unstudio.udpl.command.anno.TabComplete;
 
 public class ExampleCommand {
 
 	@Command(value = {}, // 指令名
-			senders = Player.class, // 接收的指令发送者类型
-			permission = "example.sendmessage")// 执行指令必须的权限
+			senders = Player.class) // 接收的指令发送者类型
+	@Alias("help") // 指令别名
+	@Alias("info") // 指令别名
 	public void example(Player player) { // 可选参数，value是默认值，usage是参数的用法
 		player.sendMessage(ExamplePlugin.I18N.format(player, "example.i18n"));
 	}
@@ -22,4 +32,33 @@ public void sendMessage(Player player,
 							@Optional(value = "false", name = "前缀") boolean prefix) { // 可选参数，value是默认值，usage是参数的用法
 		player.sendMessage(prefix?player.getDisplayName()+":"+message:message);
 	}
+	
+	@Command(value = "give",
+			senders = Player.class,
+			permission = "example.give")
+	public void give(Player player, 
+					@Required(name = "物品") Material material,
+					@Optional(value = "1", name = "数量") int amount,
+					@Optional(value = "0", name = "损害值") short damage) {
+		player.getInventory().addItem(new ItemStack(material, amount, damage));
+	}
+	
+	private static final String[] COMMON_WORDS = new String[] { "233", "666", "大吉大利，晚上吃鸡" };
+	private static final String[] BOOLEANS = new String[] { "true", "false" };
+
+	@TabComplete("sendmessage") // 需要处理自动补全的指令
+	public List<String> sendMessageTabComplete(String[] args) {
+		switch (args.length) {
+		case 1: {
+			String prefix = args[args.length - 1];
+			return Arrays.stream(COMMON_WORDS).filter(value -> value.startsWith(prefix)).collect(Collectors.toList());
+		}
+		case 2: {
+			String prefix = args[args.length - 1];
+			return Arrays.stream(BOOLEANS).filter(value -> value.startsWith(prefix)).collect(Collectors.toList());
+		}
+		default:
+			return Collections.emptyList();
+		}
+	}
 }

example/team/unstudio/udpl/example/ExamplePlugin.java

@@ -1,6 +1,7 @@
 package team.unstudio.udpl.example;
 import java.io.File;
 
+import org.bukkit.Material;
 import org.bukkit.entity.Player;
 import org.bukkit.plugin.java.JavaPlugin;
 
@@ -18,6 +19,7 @@ public void onEnable() {
 		I18N = new SimpleI18n(new File(getDataFolder(), "lang"));
 		Player player = null;
 		player.sendMessage(ExamplePlugin.I18N.localize(player, "example.i18n"));
-		AnnoCommandManager.builder().name("example").plugin(this).build().addHandler(new ExampleCommand()).registerCommand();
+		AnnoCommandManager.builder().name("example").plugin(this).parameterHandler(Material.class, new MaterialParameterHandler()).build()
+		.addHandler(new ExampleCommand()).registerCommand();
 	}
 }

example/team/unstudio/udpl/example/MaterialParameterHandler.java

@@ -0,0 +1,26 @@
+package team.unstudio.udpl.example;
+
+import java.util.Arrays;
+import java.util.List;
+import java.util.stream.Collectors;
+
+import org.bukkit.Material;
+
+import team.unstudio.udpl.command.anno.CommandParameterHandler;
+
+public class MaterialParameterHandler implements CommandParameterHandler{
+
+	@Override
+	public Object transform(String value) {
+		return Material.valueOf(value);
+	}
+	
+	@Override
+	public List<String> tabComplete(String value) {
+		return Arrays.stream(Material.values())
+				.map(material->material.name())
+				.filter(material->material.startsWith(value))
+				.collect(Collectors.toList());
+	}
+
+}

src/main/java/team/unstudio/udpl/command/anno/CommandParameterHandler.java

@@ -12,8 +12,18 @@
 
 public interface CommandParameterHandler {
 
+	/**
+	 * 参数转换
+	 * @param value
+	 * @return
+	 */
 	Object transform(String value);
 
+	/**
+	 * 参数自动补全
+	 * @param value
+	 * @return
+	 */
 	default List<String> tabComplete(String value){
 		return Collections.emptyList();
 	}

src/main/java/team/unstudio/udpl/command/anno/CommandWrapper.java

@@ -227,7 +227,9 @@ public List<String> onTabComplete(String[] args){
 
 		if(!hasTabComplete()){
 			try {
-				tabComplete.addAll((List<String>) tabCompleter.invoke(tabCompleterObject, new Object[]{args}));
+				List<String> completed = (List<String>) tabCompleter.invoke(tabCompleterObject, new Object[]{args});
+				if(completed != null)
+					tabComplete.addAll(completed);
 			} catch (Exception e) {
 				e.printStackTrace();
 			}