[1.4.0]refactor(all): project reformatted.

BREAKING CHANGE: reformatted projects including project settings and package paths.

platform/bukkit/general/pom.xml

@@ -0,0 +1,51 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <parent>
+        <artifactId>mineconfiguration-bukkit</artifactId>
+        <groupId>cc.carm.lib</groupId>
+        <version>1.4.0</version>
+    </parent>
+    <modelVersion>4.0.0</modelVersion>
+    <properties>
+        <maven.compiler.source>${java.version}</maven.compiler.source>
+        <maven.compiler.target>${java.version}</maven.compiler.target>
+    </properties>
+
+    <artifactId>mineconfiguration-bukkit-general</artifactId>
+    <packaging>jar</packaging>
+
+    <dependencies>
+
+        <dependency>
+            <groupId>${project.parent.groupId}</groupId>
+            <artifactId>mineconfiguration-bukkit-base</artifactId>
+            <version>${project.parent.version}</version>
+            <scope>compile</scope>
+        </dependency>
+
+    </dependencies>
+
+    <build>
+        <plugins>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-compiler-plugin</artifactId>
+            </plugin>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-jar-plugin</artifactId>
+            </plugin>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-source-plugin</artifactId>
+            </plugin>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-javadoc-plugin</artifactId>
+            </plugin>
+        </plugins>
+    </build>
+
+</project>

platform/bukkit/general/src/main/java/cc/carm/lib/configuration/minecraft/MineConfiguration.java

@@ -0,0 +1,41 @@
+package cc.carm.lib.configuration.minecraft;
+
+import cc.carm.lib.configuration.minecraft.bukkit.source.BukkitConfigProvider;
+import org.bukkit.plugin.Plugin;
+
+import java.io.File;
+import java.io.IOException;
+
+public class MineConfiguration {
+
+    public static BukkitConfigProvider from(File file, String source) {
+        BukkitConfigProvider provider = new BukkitConfigProvider(file);
+        try {
+            provider.initializeFile(source);
+            provider.initializeConfig();
+        } catch (IOException e) {
+            e.printStackTrace();
+        }
+        return provider;
+    }
+
+    public static BukkitConfigProvider from(File file) {
+        return from(file, file.getName());
+    }
+
+    public static BukkitConfigProvider from(String fileName) {
+        return from(fileName, fileName);
+    }
+
+    public static BukkitConfigProvider from(String fileName, String source) {
+        return from(new File(fileName), source);
+    }
+
+    public static BukkitConfigProvider from(Plugin plugin, String fileName) {
+        return from(plugin, fileName, fileName);
+    }
+
+    public static BukkitConfigProvider from(Plugin plugin, String fileName, String source) {
+        return from(new File(plugin.getDataFolder(), fileName), source);
+    }
+}

platform/bukkit/general/src/main/java/cc/carm/lib/configuration/minecraft/bukkit/source/BukkitConfigProvider.java

@@ -0,0 +1,77 @@
+package cc.carm.lib.configuration.minecraft.bukkit.source;
+
+import cc.carm.lib.configuration.core.ConfigInitializer;
+import org.bukkit.configuration.file.YamlConfiguration;
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
+import org.jetbrains.annotations.Unmodifiable;
+
+import java.io.BufferedWriter;
+import java.io.File;
+import java.io.StringWriter;
+import java.nio.charset.StandardCharsets;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.util.List;
+
+public class BukkitConfigProvider extends CraftConfigProvider {
+
+    protected static final char SEPARATOR = '.';
+
+    protected BukkitYAMLComments bukkitComments = new BukkitYAMLComments();
+
+    public BukkitConfigProvider(@NotNull File file) {
+        super(file);
+    }
+
+    public void initializeConfig() {
+        this.configuration = YamlConfiguration.loadConfiguration(file);
+        this.initializer = new ConfigInitializer<>(this);
+    }
+
+    @Override
+    public @NotNull CraftSectionWrapper getConfiguration() {
+        return CraftSectionWrapper.of(this.configuration);
+    }
+
+    @Override
+    public void reload() throws Exception {
+        configuration.load(getFile());
+    }
+
+    @Override
+    public void save() throws Exception {
+        configuration.save(getFile());
+
+        StringWriter writer = new StringWriter();
+        this.bukkitComments.writeComments(configuration, new BufferedWriter(writer));
+        String value = writer.toString(); // config contents
+
+        Path toUpdatePath = getFile().toPath();
+        if (!value.equals(new String(Files.readAllBytes(toUpdatePath), StandardCharsets.UTF_8))) {
+            Files.write(toUpdatePath, value.getBytes(StandardCharsets.UTF_8));
+        }
+    }
+
+    @Override
+    public void setHeaderComment(@Nullable String path, @Nullable List<String> comments) {
+        this.bukkitComments.setHeaderComments(path, comments);
+    }
+
+    @Override
+    public void setInlineComment(@NotNull String path, @Nullable String comment) {
+        this.bukkitComments.setInlineComment(path, comment);
+    }
+
+    @Override
+    @Nullable
+    @Unmodifiable
+    public List<String> getHeaderComment(@Nullable String path) {
+        return this.bukkitComments.getHeaderComment(path);
+    }
+
+    @Override
+    public @Nullable String getInlineComment(@NotNull String path) {
+        return this.bukkitComments.getInlineComment(path);
+    }
+}

platform/bukkit/general/src/main/java/cc/carm/lib/configuration/minecraft/bukkit/source/BukkitYAMLComments.java

@@ -0,0 +1,148 @@
+package cc.carm.lib.configuration.minecraft.bukkit.source;
+
+import org.bukkit.configuration.ConfigurationSection;
+import org.bukkit.configuration.file.FileConfiguration;
+import org.bukkit.configuration.file.YamlConfiguration;
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
+import org.jetbrains.annotations.Unmodifiable;
+
+import java.io.BufferedWriter;
+import java.io.IOException;
+import java.util.*;
+import java.util.stream.Collectors;
+import java.util.stream.IntStream;
+
+import static cc.carm.lib.configuration.minecraft.bukkit.source.CraftConfigProvider.SEPARATOR;
+
+public class BukkitYAMLComments {
+
+    protected final @NotNull Map<String, List<String>> headerComments = new HashMap<>();
+    protected final @NotNull Map<String, String> inlineComments = new HashMap<>();
+
+    protected @NotNull Map<String, List<String>> getHeaderComments() {
+        return headerComments;
+    }
+
+    protected @NotNull Map<String, String> getInlineComments() {
+        return inlineComments;
+    }
+
+    public void setHeaderComments(@Nullable String path, @Nullable List<String> comments) {
+
+        if (comments == null) {
+            getHeaderComments().remove(path);
+        } else {
+            getHeaderComments().put(path, comments);
+        }
+    }
+
+
+    public void setInlineComment(@NotNull String path, @Nullable String comment) {
+        if (comment == null) {
+            getInlineComments().remove(path);
+        } else {
+            getInlineComments().put(path, comment);
+        }
+    }
+
+    @Nullable
+    @Unmodifiable
+    public List<String> getHeaderComment(@Nullable String path) {
+        return Optional.ofNullable(getHeaderComments().get(path)).map(Collections::unmodifiableList).orElse(null);
+    }
+
+    public @Nullable String getInlineComment(@NotNull String path) {
+        return getInlineComments().get(path);
+    }
+
+    public @Nullable String buildHeaderComments(@Nullable String path, @NotNull String indents) {
+        List<String> comments = getHeaderComment(path);
+        if (comments == null || comments.size() == 0) return null;
+
+        StringJoiner joiner = new StringJoiner("\n");
+        for (String comment : comments) {
+            if (comment.length() == 0) joiner.add(" ");
+            else joiner.add(indents + "# " + comment);
+        }
+        return joiner + "\n";
+    }
+
+    /**
+     * 从一个文件读取配置并写入注释到某个写入器中。
+     * 该方法的部分源代码借鉴自 tchristofferson/ConfigUpdater 项目。
+     *
+     * @param source 源配置文件
+     * @param writer 配置写入器
+     * @throws IOException 当写入发生错误时抛出
+     */
+    public void writeComments(@NotNull YamlConfiguration source, @NotNull BufferedWriter writer) throws IOException {
+        FileConfiguration temp = new YamlConfiguration(); // 该对象用于临时记录配置内容
+
+        String configHeader = buildHeaderComments(null, "");
+        if (configHeader != null) writer.write(configHeader);
+
+        for (String fullKey : source.getKeys(true)) {
+            Object currentValue = source.get(fullKey);
+
+            String indents = getIndents(fullKey);
+            String headerComments = buildHeaderComments(fullKey, indents);
+            String inlineComment = getInlineComment(fullKey);
+
+            if (headerComments != null) writer.write(headerComments);
+
+            String[] splitFullKey = fullKey.split("[" + SEPARATOR + "]");
+            String trailingKey = splitFullKey[splitFullKey.length - 1];
+
+            if (currentValue instanceof ConfigurationSection) {
+                ConfigurationSection section = (ConfigurationSection) currentValue;
+                writer.write(indents + trailingKey + ":");
+                if (inlineComment != null && inlineComment.length() > 0) {
+                    writer.write(" # " + inlineComment);
+                }
+                if (!section.getKeys(false).isEmpty()) {
+                    writer.write("\n");
+                } else {
+                    writer.write(" {}\n");
+                    if (indents.length() == 0) writer.write("\n");
+                }
+                continue;
+            }
+
+            temp.set(trailingKey, currentValue);
+            String yaml = temp.saveToString();
+            temp.set(trailingKey, null);
+
+            yaml = yaml.substring(0, yaml.length() - 1);
+
+            if (inlineComment != null && inlineComment.length() > 0) {
+                if (yaml.contains("\n")) {
+                    // section为多行内容，需要 InlineComment 加在首行末尾
+                    String[] splitLine = yaml.split("\n", 2);
+                    yaml = splitLine[0] + " # " + inlineComment + "\n" + splitLine[1];
+                } else {
+                    // 其他情况下就直接加载后面就好。
+                    yaml += " # " + inlineComment;
+                }
+            }
+
+            writer.write(indents + yaml.replace("\n", "\n" + indents) + "\n");
+            if (indents.length() == 0) writer.write("\n");
+        }
+
+        writer.close();
+    }
+
+    /**
+     * 得到一个键的缩进。
+     * 该方法的源代码来自 tchristofferson/ConfigUpdater 项目。
+     *
+     * @param key 键
+     * @return 该键的缩进文本
+     */
+    protected static String getIndents(String key) {
+        String[] splitKey = key.split("[" + BukkitConfigProvider.SEPARATOR + "]");
+        return IntStream.range(1, splitKey.length).mapToObj(i -> "  ").collect(Collectors.joining());
+    }
+
+}