更新文档, 移动 LuaTableBuilder.java 至 api包下

SmileYik · Oct 24, 2022 · 9743d82 · 9743d82
1 parent 5551d23
commit 9743d82
Show file tree

Hide file tree

Showing 10 changed files with 128 additions and 57 deletions.
diff --git a/docs/api/LuaTableBuilder.md b/docs/api/LuaTableBuilder.md
@@ -0,0 +1,57 @@
+
+### put
++ **Description**:  增加一个键值对.
++ **Return Type**: **LuaTableBuilder<T>**
++ **Return Desc**: 本实例对象.
++ **Usage**: `put(key:String, value:Object)`
+
+|Name|Type|Description|
+|-|-|-|
+|key|**String**|LuaTable中的键名.|
+|value|**Object**|键名对应的值.|
+### putAll
++ **Description**:  通过Map增加多个键值对.
++ **Return Type**: **LuaTableBuilder<T>**
++ **Return Desc**: 本实例对象.
++ **Usage**: `putAll(String:Map<?extends, map:?>)`
+
+|Name|Type|Description|
+|-|-|-|
+|String|**Map<?extends**|null|
+|map|**?>**|键为字符串类型的map.|
+### clear
++ **Description**:  清空当前表.
++ **Return Type**: **LuaTableBuilder<T>**
++ **Return Desc**: 本实例对象.
++ **Usage**: `clear()`
+
+|Name|Type|Description|
+|-|-|-|
+
+### remove
++ **Description**:  移除指定键的值.
++ **Return Type**: **LuaTableBuilder<T>**
++ **Return Desc**: 本实例对象.
++ **Usage**: `remove(key:String)`
+
+|Name|Type|Description|
+|-|-|-|
+|key|**String**|要移除的键名.|
+### build
++ **Description**:  建立Lua中的表.
++ **Return Type**: **T**
++ **Return Desc**: 返回所建立的表.
++ **Usage**: `build()`
+
+|Name|Type|Description|
+|-|-|-|
+
+### buildGlobal
++ **Description**:  建立Lua中的表, 并加入到当前环境的全局变量中.
++ **Return Type**: **void**
++ **Return Desc**: 
++ **Usage**: `buildGlobal(key:String)`
+
+|Name|Type|Description|
+|-|-|-|
+|key|**String**|全局变量的变量名.|
diff --git a/src/main/java/tk/smileyik/luainminecraftbukkit/api/luaconfig/LuaConfig.java b/src/main/java/tk/smileyik/luainminecraftbukkit/api/luaconfig/LuaConfig.java
@@ -1,11 +1,11 @@
 package tk.smileyik.luainminecraftbukkit.api.luaconfig;
 
 import org.keplerproject.luajava.LuaException;
+import tk.smileyik.luainminecraftbukkit.api.luatablebuilder.LuaTableBuilder;
 import tk.smileyik.luainminecraftbukkit.luaconfig.LuaConfigInsideByFile;
 import tk.smileyik.luainminecraftbukkit.luaconfig.LuaConfigInsideByScript;
 import tk.smileyik.luainminecraftbukkit.luaconfig.LuaConfigOutsideByFile;
 import tk.smileyik.luainminecraftbukkit.luaconfig.LuaConfigOutsideByScript;
-import tk.smileyik.luainminecraftbukkit.util.luatablebuilder.LuaTableBuilder;
 
 import java.io.IOException;
 import java.nio.file.Path;

diff --git a/src/main/java/tk/smileyik/luainminecraftbukkit/api/luatablebuilder/LuaTableBuilder.java b/src/main/java/tk/smileyik/luainminecraftbukkit/api/luatablebuilder/LuaTableBuilder.java
@@ -0,0 +1,61 @@
+package tk.smileyik.luainminecraftbukkit.api.luatablebuilder;
+
+import tk.smileyik.luainminecraftbukkit.util.luaenvironment.LuaEnvironment;
+import tk.smileyik.luainminecraftbukkit.util.luaenvironment.LuaEnvironmentInside;
+import tk.smileyik.luainminecraftbukkit.util.luaenvironment.LuaEnvironmentOutside;
+import tk.smileyik.luainminecraftbukkit.util.luatablebuilder.LuaTableBuilderInside;
+import tk.smileyik.luainminecraftbukkit.util.luatablebuilder.LuaTableBuilderOutside;
+
+import java.util.Map;
+
+public interface LuaTableBuilder<T> {
+  static LuaTableBuilder<?> getBuilder(LuaEnvironment<?> luaEnvironment) {
+    if (luaEnvironment instanceof LuaEnvironmentOutside) {
+      return new LuaTableBuilderOutside(
+              (LuaEnvironmentOutside) luaEnvironment);
+    } else {
+      return new LuaTableBuilderInside(
+              (LuaEnvironmentInside) luaEnvironment);
+    }
+  }
+
+  /**
+   * 增加一个键值对.
+   * @param key   LuaTable中的键名.
+   * @param value 键名对应的值.
+   * @return 本实例对象.
+   */
+  LuaTableBuilder<T> put(String key, Object value);
+
+  /**
+   * 通过Map增加多个键值对.
+   * @param map 键为字符串类型的map.
+   * @return 本实例对象.
+   */
+  LuaTableBuilder<T> putAll(Map<? extends String, ?> map);
+
+  /**
+   * 清空当前表.
+   * @return 本实例对象.
+   */
+  LuaTableBuilder<T> clear();
+
+  /**
+   * 移除指定键的值.
+   * @param key 要移除的键名.
+   * @return 本实例对象.
+   */
+  LuaTableBuilder<T> remove(String key);
+
+  /**
+   * 建立Lua中的表.
+   * @return 返回所建立的表.
+   */
+  T build();
+
+  /**
+   * 建立Lua中的表, 并加入到当前环境的全局变量中.
+   * @param key 全局变量的变量名.
+   */
+  void buildGlobal(String key);
+}
diff --git a/src/main/java/tk/smileyik/luainminecraftbukkit/luaconfig/LuaConfigInside.java b/src/main/java/tk/smileyik/luainminecraftbukkit/luaconfig/LuaConfigInside.java
@@ -4,11 +4,11 @@
 import org.luaj.vm2.LuaValue;
 import tk.smileyik.luainminecraftbukkit.api.luaconfig.LuaConfig;
 import tk.smileyik.luainminecraftbukkit.api.luaconfig.LuaConfigEntity;
+import tk.smileyik.luainminecraftbukkit.api.luatablebuilder.LuaTableBuilder;
 import tk.smileyik.luainminecraftbukkit.luaconfig.exception.LuaConfigClosureReturnException;
 import tk.smileyik.luainminecraftbukkit.luaconfig.exception.LuaConfigNotClosureException;
 import tk.smileyik.luainminecraftbukkit.util.LuaValueUtil;
 import tk.smileyik.luainminecraftbukkit.util.luaenvironment.LuaEnvironmentInside;
-import tk.smileyik.luainminecraftbukkit.util.luatablebuilder.LuaTableBuilder;
 
 import java.text.NumberFormat;
 import java.text.ParseException;

diff --git a/src/main/java/tk/smileyik/luainminecraftbukkit/luaconfig/LuaConfigOutside.java b/src/main/java/tk/smileyik/luainminecraftbukkit/luaconfig/LuaConfigOutside.java
@@ -4,11 +4,11 @@
 import org.keplerproject.luajava.LuaObject;
 import tk.smileyik.luainminecraftbukkit.api.luaconfig.LuaConfig;
 import tk.smileyik.luainminecraftbukkit.api.luaconfig.LuaConfigEntity;
+import tk.smileyik.luainminecraftbukkit.api.luatablebuilder.LuaTableBuilder;
 import tk.smileyik.luainminecraftbukkit.luaconfig.exception.LuaConfigClosedException;
 import tk.smileyik.luainminecraftbukkit.luaconfig.exception.LuaConfigClosureReturnException;
 import tk.smileyik.luainminecraftbukkit.luaconfig.exception.LuaConfigNotClosureException;
 import tk.smileyik.luainminecraftbukkit.util.luaenvironment.LuaEnvironmentOutside;
-import tk.smileyik.luainminecraftbukkit.util.luatablebuilder.LuaTableBuilder;
 
 import java.text.NumberFormat;
 import java.text.ParseException;

diff --git a/...java/tk/smileyik/luainminecraftbukkit/luaplugin/mode/outside/LuaPluginManagerOutside.java b/...java/tk/smileyik/luainminecraftbukkit/luaplugin/mode/outside/LuaPluginManagerOutside.java
@@ -6,6 +6,7 @@
 import org.keplerproject.luajava.LuaStateFactory;
 import tk.smileyik.luainminecraftbukkit.LuaInMinecraftBukkit;
 import tk.smileyik.luainminecraftbukkit.PluginSetting;
+import tk.smileyik.luainminecraftbukkit.api.luatablebuilder.LuaTableBuilder;
 import tk.smileyik.luainminecraftbukkit.luaplugin.AbstractLuaPluginManager;
 import tk.smileyik.luainminecraftbukkit.luaplugin.LuaPlugin;
 import tk.smileyik.luainminecraftbukkit.luaplugin.exception.LuaFunctionIllegalException;
@@ -14,7 +15,6 @@
 import tk.smileyik.luainminecraftbukkit.luaplugin.exception.LuaPluginNotFountException;
 import tk.smileyik.luainminecraftbukkit.luaplugin.util.LuaPluginHelper;
 import tk.smileyik.luainminecraftbukkit.util.luaenvironment.LuaEnvironmentOutside;
-import tk.smileyik.luainminecraftbukkit.util.luatablebuilder.LuaTableBuilder;
 
 import java.io.File;
 import java.io.IOException;

diff --git a/src/main/java/tk/smileyik/luainminecraftbukkit/util/luatablebuilder/LuaTableBuilder.java b/src/main/java/tk/smileyik/luainminecraftbukkit/util/luatablebuilder/LuaTableBuilder.java
@@ -6,54 +6,7 @@
 
 import java.util.Map;
 
-public interface LuaTableBuilder <T> {
-  static LuaTableBuilder<?> getBuilder(LuaEnvironment<?> luaEnvironment) {
-    if (luaEnvironment instanceof LuaEnvironmentOutside) {
-      return new LuaTableBuilderOutside(
-              (LuaEnvironmentOutside) luaEnvironment);
-    } else {
-      return new LuaTableBuilderInside(
-              (LuaEnvironmentInside) luaEnvironment);
-    }
-  }
+@Deprecated
+public interface LuaTableBuilder <T> extends tk.smileyik.luainminecraftbukkit.api.luatablebuilder.LuaTableBuilder <T> {
 
-  /**
-   * 增加一个键值对.
-   * @param key   LuaTable中的键名.
-   * @param value 键名对应的值.
-   * @return 本实例对象.
-   */
-  LuaTableBuilder<T> put(String key, Object value);
-
-  /**
-   * 通过Map增加多个键值对.
-   * @param map 键为字符串类型的map.
-   * @return 本实例对象.
-   */
-  LuaTableBuilder<T> putAll(Map<? extends String, ?> map);
-
-  /**
-   * 清空当前表.
-   * @return 本实例对象.
-   */
-  LuaTableBuilder<T> clear();
-
-  /**
-   * 移除指定键的值.
-   * @param key 要移除的键名.
-   * @return 本实例对象.
-   */
-  LuaTableBuilder<T> remove(String key);
-
-  /**
-   * 建立Lua中的表.
-   * @return 返回所建立的表.
-   */
-  T build();
-
-  /**
-   * 建立Lua中的表, 并加入到当前环境的全局变量中.
-   * @param key 全局变量的变量名.
-   */
-  void buildGlobal(String key);
 }
diff --git a/...ain/java/tk/smileyik/luainminecraftbukkit/util/luatablebuilder/LuaTableBuilderInside.java b/...ain/java/tk/smileyik/luainminecraftbukkit/util/luatablebuilder/LuaTableBuilderInside.java
@@ -7,7 +7,7 @@
 public class LuaTableBuilderInside extends AbstractLuaTableBuilder<LuaValue> {
   private final LuaEnvironmentInside luaEnvironment;
 
-  protected LuaTableBuilderInside(LuaEnvironmentInside luaEnvironment) {
+  public LuaTableBuilderInside(LuaEnvironmentInside luaEnvironment) {
     this.luaEnvironment = luaEnvironment;
   }
 

diff --git a/...in/java/tk/smileyik/luainminecraftbukkit/util/luatablebuilder/LuaTableBuilderOutside.java b/...in/java/tk/smileyik/luainminecraftbukkit/util/luatablebuilder/LuaTableBuilderOutside.java
@@ -8,7 +8,7 @@
 public class LuaTableBuilderOutside extends AbstractLuaTableBuilder<LuaObject> {
   private final LuaEnvironmentOutside luaEnvironment;
 
-  protected LuaTableBuilderOutside(LuaEnvironmentOutside luaEnvironment) {
+  public LuaTableBuilderOutside(LuaEnvironmentOutside luaEnvironment) {
     this.luaEnvironment = luaEnvironment;
   }
 

diff --git a/src/test/java/tk/smileyik/JavadocToMarkdown.java b/src/test/java/tk/smileyik/JavadocToMarkdown.java
@@ -32,8 +32,8 @@ public String toString() {
 
 
   public static void main(String[] args) throws IOException {
-    String outName = "api/LuaConfigEntity.md";
-    String file = "/home/miskyle/workspace/idea-space/LuaInMinecraftBukkt/src/main/java/tk/smileyik/luainminecraftbukkit/api/luaconfig/LuaConfigEntity.java";
+    String outName = "api/LuaTableBuilder.md";
+    String file = "/home/miskyle/workspace/idea-space/LuaInMinecraftBukkt/src/main/java/tk/smileyik/luainminecraftbukkit/util/luatablebuilder/LuaTableBuilder.java";
     List<String> strings = Files.readAllLines(Paths.get(file));
 
     List<String> aPart = new ArrayList<>();