Add API methods to get config entries and paths from config

Author: Almighty-Satan

core/src/main/java/io/github/almightysatan/jaskl/Config.java

@@ -23,8 +23,11 @@
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 import org.jetbrains.annotations.Unmodifiable;
+import org.jetbrains.annotations.UnmodifiableView;
 
 import java.io.IOException;
+import java.util.Collection;
+import java.util.Map;
 import java.util.Set;
 
 public interface Config extends AutoCloseable {
@@ -105,4 +108,25 @@ default void strip() throws IOException, UnsupportedOperationException {
      * @throws IOException if an I/O exception occurs
      */
     boolean isReadOnly() throws IOException;
+
+    /**
+     * Returns a map of all paths with their {@link ConfigEntry}.
+     *
+     * @return a map of all paths with their {@link ConfigEntry}
+     */
+    @UnmodifiableView @NotNull Map<@NotNull String, @NotNull ConfigEntry<?>> getEntryMap();
+
+    /**
+     * Returns a collection of all paths.
+     *
+     * @return a collection of all paths
+     */
+    @UnmodifiableView @NotNull Collection<@NotNull String> getPaths();
+
+    /**
+     * Returns a collection of all {@link ConfigEntry config entries}.
+     *
+     * @return a collection of all {@link ConfigEntry config entries}
+     */
+    @UnmodifiableView @NotNull Collection<@NotNull ConfigEntry<?>> getEntries();
 }

core/src/main/java/io/github/almightysatan/jaskl/impl/ConfigImpl.java

@@ -23,6 +23,7 @@
 import io.github.almightysatan.jaskl.*;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
+import org.jetbrains.annotations.UnmodifiableView;
 
 import java.io.IOException;
 import java.util.*;
@@ -74,36 +75,24 @@ public boolean isReadOnly() throws IOException {
         return false;
     }
 
-    /**
-     * Returns a map of all paths with their config entries.
-     *
-     * @return a map of all paths with their config entries
-     */
-    public @NotNull Map<String, ConfigEntry<?>> getEntries() {
-        return entries;
+    @Override
+    public @UnmodifiableView @NotNull Map<@NotNull String, @NotNull ConfigEntry<?>> getEntryMap() {
+        return Collections.unmodifiableMap(this.entries);
     }
 
-    /**
-     * Returns a set of all the paths of the config entries.
-     *
-     * @return a set of all the paths of the config entries
-     */
-    public @NotNull Set<String> getPaths() {
-        return this.getEntries().keySet();
+    @Override
+    public @UnmodifiableView @NotNull Collection<@NotNull String> getPaths() {
+        return Collections.unmodifiableCollection(this.getEntryMap().keySet());
     }
 
-    /**
-     * Returns a collection of all config entries.
-     *
-     * @return a collection of all config entries
-     */
-    public @NotNull Collection<ConfigEntry<?>> getValues() {
-        return this.getEntries().values();
+    @Override
+    public @UnmodifiableView @NotNull Collection<@NotNull ConfigEntry<?>> getEntries() {
+        return Collections.unmodifiableCollection(this.getEntryMap().values());
     }
 
     @SuppressWarnings({"unchecked", "rawtypes"})
     protected @NotNull Collection<WritableConfigEntry<?>> getCastedValues() {
-        return (Collection<WritableConfigEntry<?>>) (Collection) getEntries().values();
+        return (Collection<WritableConfigEntry<?>>) (Collection) getEntryMap().values();
     }
 
     public ExceptionHandler getExceptionHandler() {

hocon/src/main/java/io/github/almightysatan/jaskl/hocon/HoconConfig.java

@@ -70,7 +70,7 @@ public void load() throws IllegalStateException, IOException {
     public void reload() throws IllegalStateException {
         if (this.config == null)
             throw new IllegalStateException();
-        for (ConfigEntry<?> uncastedConfigEntry : this.getValues()) {
+        for (ConfigEntry<?> uncastedConfigEntry : this.getEntries()) {
             WritableConfigEntry<?> configEntry = (WritableConfigEntry<?>) uncastedConfigEntry;
             try {
                 Object value = this.config.getValue(configEntry.getPath()).unwrapped();
@@ -139,7 +139,7 @@ protected void writeIfNecessary(@NotNull Config config, boolean setDescription)
         }
     }
 
-    protected void resolvePathsToStrip(@NotNull String path, @NotNull ConfigObject node, @NotNull Set<String> paths, @NotNull Set<String> toRemove, @NotNull Set<String> valuePathsRemoved) {
+    protected void resolvePathsToStrip(@NotNull String path, @NotNull ConfigObject node, @NotNull Collection<String> paths, @NotNull Set<String> toRemove, @NotNull Set<String> valuePathsRemoved) {
         for (Map.Entry<String, ConfigValue> entry : node.entrySet()) {
             String fieldPath = (path.isEmpty() ? "" : path + ".") + entry.getKey();
             if (entry.getValue() instanceof ConfigObject) {

jackson/src/main/java/io/github/almightysatan/jaskl/jackson/JacksonConfigImpl.java

@@ -141,7 +141,7 @@ protected void putNode(@NotNull String path, @NotNull JsonNode value) {
         node.set(pathSplit[pathSplit.length - 1], value);
     }
 
-    protected boolean stripNodes(@NotNull String path, @NotNull ObjectNode node, @NotNull Set<String> paths, @NotNull Set<String> pathsRemoved) {
+    protected boolean stripNodes(@NotNull String path, @NotNull ObjectNode node, @NotNull Collection<String> paths, @NotNull Set<String> pathsRemoved) {
         boolean changed = false;
         List<String> toRemove = new ArrayList<>();
         for (Entry<String, JsonNode> field : node.properties()) {

mongodb/src/main/java/io/github/almightysatan/jaskl/mongodb/MongodbConfig.java

@@ -129,7 +129,7 @@ public void write() throws IOException {
 
         Set<String> pathsRemoved = new HashSet<>();
         try {
-            Set<String> paths = this.getPaths();
+            Collection<String> paths = this.getPaths();
             List<WriteModel<? extends Document>> writeModels = new ArrayList<>();
             FindIterable<Document> documents = this.mongoCollection.find();
             for (Document document : documents) {

properties/src/main/java/io/github/almightysatan/jaskl/properties/PropertiesConfig.java

@@ -31,7 +31,10 @@
 import org.jetbrains.annotations.Nullable;
 import org.jetbrains.annotations.Unmodifiable;
 
-import java.io.*;
+import java.io.File;
+import java.io.IOException;
+import java.io.Reader;
+import java.io.Writer;
 import java.util.*;
 import java.util.Map.Entry;
 
@@ -91,7 +94,7 @@ public void write() throws IOException {
             return Collections.emptySet();
 
         Properties stripped = new Properties();
-        Set<String> paths = this.getPaths();
+        Collection<String> paths = this.getPaths();
         Set<String> pathsRemoved = new HashSet<>();
         for (Entry<Object, Object> entry : this.config.entrySet()) {
             String key = (String) entry.getKey();

yaml/src/main/java/io/github/almightysatan/jaskl/yaml/YamlConfig.java

@@ -164,7 +164,7 @@ protected void loadValues(@NotNull String path, @NotNull MappingNode node) {
      * @return true if the entry exists
      */
     protected boolean loadValueIfEntryExists(String path, Node node) {
-        WritableConfigEntry<?> entry = (WritableConfigEntry<?>) this.getEntries().get(path);
+        WritableConfigEntry<?> entry = (WritableConfigEntry<?>) this.getEntryMap().get(path);
         if (entry == null)
             return false;
         Object value = CONSTRUCTOR.constructObject(node);
@@ -223,7 +223,7 @@ protected void setComment(@NotNull Node node, @Nullable String comment) {
             node.setBlockComments(Collections.emptyList()); // Remove comment
     }
 
-    protected boolean stripNodes(@NotNull String path, @NotNull MappingNode node, @NotNull Set<String> paths, @NotNull Set<String> removedPaths) {
+    protected boolean stripNodes(@NotNull String path, @NotNull MappingNode node, @NotNull Collection<String> paths, @NotNull Set<String> removedPaths) {
         boolean changed = false;
         List<NodeTuple> toRemove = new ArrayList<>();
         for (NodeTuple tuple : node.getValue()) {