Comments improvements

Author: mikigal

src/main/java/pl/mikigal/config/BukkitConfiguration.java

@@ -27,62 +27,29 @@
  */
 public class BukkitConfiguration extends YamlConfiguration {
 
-	private static final Field yamlOptionsField;
-	private static final Field yamlRepresenterField;
-	private static final Field yamlField;
-
-	static {
-		try {
-			yamlOptionsField = YamlConfiguration.class.getDeclaredField("yamlOptions");
-			yamlOptionsField.setAccessible(true);
-
-			yamlRepresenterField = YamlConfiguration.class.getDeclaredField("yamlRepresenter");
-			yamlRepresenterField.setAccessible(true);
-
-			yamlField = YamlConfiguration.class.getDeclaredField("yaml");
-			yamlField.setAccessible(true);
-		} catch (NoSuchFieldException e) {
-			throw new InvalidConfigException("Could not find Fields of YamlConfiguration", e);
-		}
-	}
-
 	/**
 	 * Properties of config
 	 */
 	private final File file;
 	private final NameStyle nameStyle;
 	private final CommentStyle commentStyle;
 	private final boolean automaticColorStrings;
+	private final String configComment;
 
 	/**
 	 * Caches
 	 */
 	private final Map<String, Object> cache;
 	private final Map<String, String> comments;
 
-	/**
-	 * Internal objects from YamlConfiguration, needed for handling comments
-	 * @see YamlConfiguration
-	 */
-	private final DumperOptions yamlOptions;
-	private final YamlRepresenter yamlRepresenter;
-	private final Yaml yaml;
-
-	public BukkitConfiguration(File file, NameStyle nameStyle, CommentStyle commentStyle, boolean automaticColorStrings) {
+	public BukkitConfiguration(File file, NameStyle nameStyle, CommentStyle commentStyle, boolean automaticColorStrings, String configComment) {
 		this.file = file;
 		this.nameStyle = nameStyle;
 		this.commentStyle = commentStyle;
 		this.automaticColorStrings = automaticColorStrings;
 		this.cache = new HashMap<>();
 		this.comments = new HashMap<>();
-
-		try {
-			this.yamlOptions = (DumperOptions) yamlOptionsField.get(this);
-			this.yamlRepresenter = (YamlRepresenter) yamlRepresenterField.get(this);
-			this.yaml = (Yaml) yamlField.get(this);
-		} catch (IllegalAccessException e) {
-			throw new InvalidConfigException("Could not get values of Fields in YamlConfiguration", e);
-		}
+		this.configComment = configComment;
 
 		this.copyDefaultConfig();
 		this.load();
@@ -138,40 +105,38 @@ public Object get(String path) {
 
 	/**
 	 * Workaround for writing comments to .yml file, Bukkit does to allow to do it
-	 * @return yml content as String
+	 * @return Content of config parsed to YAML
 	 */
 	@Override
 	public String saveToString() {
-		this.yamlOptions.setIndent(this.options().indent());
-		this.yamlOptions.setDefaultFlowStyle(DumperOptions.FlowStyle.BLOCK);
-		this.yamlOptions.setAllowUnicode(true);
-		this.yamlRepresenter.setDefaultFlowStyle(DumperOptions.FlowStyle.BLOCK);
-
-		String header = this.buildHeader();
-		String dump = yaml.dump(this.getValues(false));
-		if (dump.equals("{}\n")) {
-			dump = "";
-		}
+		String yaml = super.saveToString();
 
 		List<String> lines = new ArrayList<>();
-		for (String line : (header + dump).split("\n")) {
-			if (!line.contains(":") || line.startsWith(" ")) {
+		if (this.configComment != null) {
+			lines.add(this.configComment);
+		}
+
+		for (String line : yaml.split("\n")) {
+			// It's not line with new field
+			if (!line.contains(":") || line.startsWith(" ") || line.startsWith("\t")) {
 				lines.add(line);
 				continue;
 			}
 
-			String key = line.split(":")[0];
-			String comment = this.comments.get(key);
-			if (comment != null) {
-				if (this.commentStyle == CommentStyle.ABOVE_CONTENT) {
-					lines.add("# " + comment);
-				} else {
-					lines.add(line + " # " + comment);
-				}
+			String configFieldName = line.split(":")[0];
+			String comment = this.comments.get(configFieldName);
+			if (comment == null) {
+				lines.add(line);
+				continue;
+			}
 
+			if (this.commentStyle == CommentStyle.INLINE) {
+				lines.add(line + " # " + comment);
 				continue;
 			}
 
+			// ABOVE_CONTENT
+			lines.add("# " + comment);
 			lines.add(line);
 		}
 

src/main/java/pl/mikigal/config/ConfigAPI.java

@@ -1,6 +1,7 @@
 package pl.mikigal.config;
 
 import org.bukkit.plugin.java.JavaPlugin;
+import pl.mikigal.config.annotation.Comment;
 import pl.mikigal.config.annotation.ConfigName;
 import pl.mikigal.config.exception.InvalidConfigException;
 import pl.mikigal.config.serializer.Serializer;
@@ -47,20 +48,25 @@ public class ConfigAPI {
 	 * @see CommentStyle
 	 * @return Instance of {@param clazz} ready to use methods
 	 */
-	public static <T extends Config> T init(Class<T> clazz, NameStyle nameStyle, CommentStyle commentStyle, boolean automaticColorStrings, JavaPlugin plugin) {
+	public static <T extends Config> T init(Class<T> clazz, NameStyle nameStyle, CommentStyle commentStyle,
+											boolean automaticColorStrings, JavaPlugin plugin) {
 		ConfigAPI.plugin = plugin;
 		ConfigName configName = clazz.getAnnotation(ConfigName.class);
 		if (configName == null) {
 			throw new InvalidConfigException("Config must have annotation ConfigName with file's name");
 		}
 
+		Comment configCommentAnnotation = clazz.getAnnotation(Comment.class);
+		String configComment = configCommentAnnotation == null ? null : configCommentAnnotation.value();
+
 		String name = configName.value() + (configName.value().endsWith(".yml") ? "" : ".yml");
 		File file = new File(plugin.getDataFolder(), name);
 
-		BukkitConfiguration rawConfiguration = new BukkitConfiguration(file, nameStyle, commentStyle, automaticColorStrings);
+		BukkitConfiguration rawConfiguration = new BukkitConfiguration(file, nameStyle, commentStyle, automaticColorStrings, configComment);
 		rawConfigurations.put(name, rawConfiguration);
 
-		T configuration = (T) Proxy.newProxyInstance(clazz.getClassLoader(), new Class[]{clazz}, new ConfigInvocationHandler(clazz, rawConfiguration, automaticColorStrings));
+		T configuration = (T) Proxy.newProxyInstance(clazz.getClassLoader(), new Class[]{clazz},
+				new ConfigInvocationHandler(clazz, rawConfiguration, automaticColorStrings));
 		configurations.put(name, configuration);
 
 		return configuration;

src/main/java/pl/mikigal/config/annotation/Comment.java

@@ -7,10 +7,12 @@
 
 /**
  * Allows to create comment for field in config
+ * New lines can be made with <code>\n</code> if annotation is used for class or CommentStyle is ABOVE_CONTENT
+ * @see pl.mikigal.config.style.CommentStyle
  * @since 1.0
  * @author Mikołaj Gałązka
  */
-@Target({ElementType.METHOD})
+@Target({ElementType.METHOD, ElementType.TYPE})
 @Retention(value = RetentionPolicy.RUNTIME)
 public @interface Comment {
 	String value();