core: Add getComments and setComments, resolve #20

TheElectronWill · Apr 26, 2017 · 0024db9 · 0024db9
1 parent 82cef7a
commit 0024db9
Show file tree

Hide file tree

Showing 6 changed files with 150 additions and 0 deletions.
diff --git a/core/src/main/java/com/electronwill/nightconfig/core/CommentedConfig.java b/core/src/main/java/com/electronwill/nightconfig/core/CommentedConfig.java
@@ -56,6 +56,49 @@ default String removeComment(String path) {
 	 */
 	void clearComments();
 
+	/**
+	 * Sets the comments of the config to the content of the specified Map. The Map isn't
+	 * directly used, its content is copied.
+	 *
+	 * @param comments the comments to set
+	 */
+	default void setComments(Map<String, CommentNode> comments) {
+		for (Map.Entry<String, CommentNode> entry : comments.entrySet()) {
+			String key = entry.getKey();
+			CommentNode node = entry.getValue();
+			String comment = node.getComment();
+			if (comment != null) {
+				setComment(Collections.singletonList(key), comment);
+			}
+			Map<String, CommentNode> children = node.getChildren();
+			if (children != null) {
+				CommentedConfig config = getValue(Collections.singletonList(key));
+				config.setComments(children);
+			}
+		}
+	}
+
+	/**
+	 * Copies the comments of a config to this config.
+	 *
+	 * @param commentedConfig the config to copy its comments
+	 */
+	default void setComments(UnmodifiableCommentedConfig commentedConfig) {
+		for (UnmodifiableCommentedConfig.Entry entry : commentedConfig.entrySet()) {
+			String key = entry.getKey();
+			String comment = entry.getComment();
+			if (comment != null) {
+				setComment(Collections.singletonList(key), comment);
+			}
+			Object value = entry.getValue();
+			if (value instanceof UnmodifiableCommentedConfig) {
+				CommentedConfig config = getValue(Collections.singletonList(key));
+				config.setComments((UnmodifiableCommentedConfig)value);
+			}
+
+		}
+	}
+
 	@Override
 	default UnmodifiableCommentedConfig unmodifiable() {
 		return new UnmodifiableCommentedConfig() {
@@ -94,6 +137,11 @@ public Map<String, String> commentMap() {
 				return Collections.unmodifiableMap(CommentedConfig.this.commentMap());
 			}
 
+			@Override
+			public Map<String, CommentNode> getComments() {
+				return CommentedConfig.this.getComments();
+			}
+
 			@Override
 			public Set<? extends Entry> entrySet() {
 				return CommentedConfig.this.entrySet();

diff --git a/core/src/main/java/com/electronwill/nightconfig/core/UnmodifiableCommentedConfig.java b/core/src/main/java/com/electronwill/nightconfig/core/UnmodifiableCommentedConfig.java
@@ -1,5 +1,6 @@
 package com.electronwill.nightconfig.core;
 
+import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
 import java.util.Optional;
@@ -82,6 +83,58 @@ default boolean containsComment(String path) {
 	 */
 	Map<String, String> commentMap();
 
+	/**
+	 * Returns a Map containing a deep copy of all the comments in the config.
+	 *
+	 * @return a Map containing the comments in the config.
+	 */
+	default Map<String, CommentNode> getComments() {
+		Map<String, CommentNode> map = new HashMap<>();
+		for (Entry entry : entrySet()) {
+			String key = entry.getKey();
+			String comment = entry.getComment();
+			Object value = entry.getValue();
+			if (comment != null || value instanceof UnmodifiableCommentedConfig) {
+				Map<String, CommentNode> children = (value instanceof UnmodifiableCommentedConfig)
+													? ((UnmodifiableCommentedConfig)value).getComments()
+													: null;
+				CommentNode node = new CommentNode(comment, children);
+				map.put(key, node);
+			}
+		}
+		return map;
+	}
+
+	final class CommentNode {
+		private final String comment;
+		private final Map<String, CommentNode> children;
+
+		/**
+		 * Creates a new CommentNode.
+		 *
+		 * @param comment  the comment
+		 * @param children the children Map, may be null
+		 */
+		public CommentNode(String comment, Map<String, CommentNode> children) {
+			this.comment = comment;
+			this.children = children;
+		}
+
+		/**
+		 * @return the node's comment
+		 */
+		public String getComment() {
+			return comment;
+		}
+
+		/**
+		 * @return the Map of the node's children
+		 */
+		public Map<String, CommentNode> getChildren() {
+			return children;
+		}
+	}
+
 	@Override
 	Set<? extends Entry> entrySet();
 

diff --git a/.../src/main/java/com/electronwill/nightconfig/core/conversion/CommentedConvertedConfig.java b/.../src/main/java/com/electronwill/nightconfig/core/conversion/CommentedConvertedConfig.java
@@ -1,6 +1,7 @@
 package com.electronwill.nightconfig.core.conversion;
 
 import com.electronwill.nightconfig.core.CommentedConfig;
+import com.electronwill.nightconfig.core.UnmodifiableCommentedConfig;
 import com.electronwill.nightconfig.core.utils.TransformingSet;
 import java.util.List;
 import java.util.Map;
@@ -70,6 +71,21 @@ public void clearComments() {
 		config.clearComments();
 	}
 
+	@Override
+	public Map<String, CommentNode> getComments() {
+		return config.getComments();
+	}
+
+	@Override
+	public void setComments(Map<String, CommentNode> comments) {
+		config.setComments(comments);
+	}
+
+	@Override
+	public void setComments(UnmodifiableCommentedConfig commentedConfig) {
+		config.setComments(commentedConfig);
+	}
+
 	@Override
 	public Map<String, String> commentMap() {
 		return config.commentMap();

diff --git a/core/src/main/java/com/electronwill/nightconfig/core/utils/CommentedConfigWrapper.java b/core/src/main/java/com/electronwill/nightconfig/core/utils/CommentedConfigWrapper.java
@@ -1,6 +1,7 @@
 package com.electronwill.nightconfig.core.utils;
 
 import com.electronwill.nightconfig.core.CommentedConfig;
+import com.electronwill.nightconfig.core.UnmodifiableCommentedConfig;
 import java.util.List;
 import java.util.Map;
 import java.util.Set;
@@ -49,4 +50,19 @@ public Set<? extends CommentedConfig.Entry> entrySet() {
 	public void clearComments() {
 		config.clearComments();
 	}
+
+	@Override
+	public void setComments(Map<String, CommentNode> comments) {
+		config.setComments(comments);
+	}
+
+	@Override
+	public void setComments(UnmodifiableCommentedConfig commentedConfig) {
+		config.setComments(commentedConfig);
+	}
+
+	@Override
+	public Map<String, CommentNode> getComments() {
+		return config.getComments();
+	}
 }
diff --git a/core/src/main/java/com/electronwill/nightconfig/core/utils/FakeCommentedConfig.java b/core/src/main/java/com/electronwill/nightconfig/core/utils/FakeCommentedConfig.java
@@ -2,6 +2,7 @@
 
 import com.electronwill.nightconfig.core.CommentedConfig;
 import com.electronwill.nightconfig.core.Config;
+import com.electronwill.nightconfig.core.UnmodifiableCommentedConfig;
 import java.util.Collections;
 import java.util.List;
 import java.util.Map;
@@ -61,6 +62,17 @@ public String removeComment(List<String> path) {
 	@Override
 	public void clearComments() {}
 
+	@Override
+	public Map<String, CommentNode> getComments() {
+		return Collections.emptyMap();
+	}
+
+	@Override
+	public void setComments(Map<String, CommentNode> comments) {}
+
+	@Override
+	public void setComments(UnmodifiableCommentedConfig commentedConfig) {}
+
 	@Override
 	public Map<String, String> commentMap() {
 		return Collections.emptyMap();

diff --git a/...rc/main/java/com/electronwill/nightconfig/core/utils/FakeUnmodifiableCommentedConfig.java b/...rc/main/java/com/electronwill/nightconfig/core/utils/FakeUnmodifiableCommentedConfig.java
@@ -50,6 +50,11 @@ public boolean containsComment(List<String> path) {
 		return false;
 	}
 
+	@Override
+	public Map<String, CommentNode> getComments() {
+		return Collections.emptyMap();
+	}
+
 	@Override
 	public Map<String, String> commentMap() {
 		return Collections.emptyMap();