Merge pull request #22 from dejvokep/development

New settings setters and change of document constructors access to protected

LICENSE-header.txt

@@ -1,4 +1,4 @@
-Copyright 2022 https://dejvokep.dev/
+Copyright 2024 https://dejvokep.dev/
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

pom.xml

@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!--
 
-    Copyright 2022 https://dejvokep.dev/
+    Copyright 2024 https://dejvokep.dev/
 
     Licensed under the Apache License, Version 2.0 (the "License");
     you may not use this file except in compliance with the License.
@@ -24,7 +24,7 @@
     <!-- Artifact data -->
     <artifactId>boosted-yaml</artifactId>
     <groupId>dev.dejvokep</groupId>
-    <version>1.3.1</version>
+    <version>1.3.2</version>
     <name>BoostedYAML</name>
     <description>A simple-to-use library delivering boosted experience while working with YAML files.</description>
     <url>https://github.com/dejvokep/boosted-yaml</url>

src/main/java/dev/dejvokep/boostedyaml/block/Block.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2022 https://dejvokep.dev/
+ * Copyright 2024 https://dejvokep.dev/
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -41,7 +41,7 @@ public abstract class Block<T> {
     //Comments
     List<CommentLine> beforeKeyComments = new ArrayList<>(0), inlineKeyComments = null, afterKeyComments = null, beforeValueComments = null, inlineValueComments = null, afterValueComments = null;
     //Value
-    private final T value;
+    private T value;
     //If to ignore
     private boolean ignored;
 
@@ -192,6 +192,15 @@ private List<CommentLine> toBlockComments(@NotNull List<CommentLine> commentLine
         return commentLines;
     }
 
+    /**
+     * Sets a new value.
+     *
+     * @param value the new value
+     */
+    public void setValue(T value) {
+        this.value = value;
+    }
+
     /**
      * Returns comments at the given position.
      * <p>

src/main/java/dev/dejvokep/boostedyaml/block/Comments.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2022 https://dejvokep.dev/
+ * Copyright 2024 https://dejvokep.dev/
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

src/main/java/dev/dejvokep/boostedyaml/block/implementation/Section.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2022 https://dejvokep.dev/
+ * Copyright 2024 https://dejvokep.dev/
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

src/main/java/dev/dejvokep/boostedyaml/block/implementation/TerminatedBlock.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2022 https://dejvokep.dev/
+ * Copyright 2024 https://dejvokep.dev/
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

src/main/java/dev/dejvokep/boostedyaml/dvs/Pattern.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2022 https://dejvokep.dev/
+ * Copyright 2024 https://dejvokep.dev/
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

src/main/java/dev/dejvokep/boostedyaml/dvs/Version.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2022 https://dejvokep.dev/
+ * Copyright 2024 https://dejvokep.dev/
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

src/main/java/dev/dejvokep/boostedyaml/dvs/segment/LiteralSegment.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2022 https://dejvokep.dev/
+ * Copyright 2024 https://dejvokep.dev/
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

src/main/java/dev/dejvokep/boostedyaml/dvs/segment/RangeSegment.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2022 https://dejvokep.dev/
+ * Copyright 2024 https://dejvokep.dev/
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

src/main/java/dev/dejvokep/boostedyaml/dvs/segment/Segment.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2022 https://dejvokep.dev/
+ * Copyright 2024 https://dejvokep.dev/
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

src/main/java/dev/dejvokep/boostedyaml/dvs/versioning/AutomaticVersioning.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2022 https://dejvokep.dev/
+ * Copyright 2024 https://dejvokep.dev/
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

src/main/java/dev/dejvokep/boostedyaml/dvs/versioning/BasicVersioning.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2022 https://dejvokep.dev/
+ * Copyright 2024 https://dejvokep.dev/
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

src/main/java/dev/dejvokep/boostedyaml/dvs/versioning/ManualVersioning.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2022 https://dejvokep.dev/
+ * Copyright 2024 https://dejvokep.dev/
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

src/main/java/dev/dejvokep/boostedyaml/dvs/versioning/Versioning.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2022 https://dejvokep.dev/
+ * Copyright 2024 https://dejvokep.dev/
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

src/main/java/dev/dejvokep/boostedyaml/engine/ExtendedConstructor.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2022 https://dejvokep.dev/
+ * Copyright 2024 https://dejvokep.dev/
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

src/main/java/dev/dejvokep/boostedyaml/engine/ExtendedRepresenter.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2022 https://dejvokep.dev/
+ * Copyright 2024 https://dejvokep.dev/
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

src/main/java/dev/dejvokep/boostedyaml/route/Route.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2022 https://dejvokep.dev/
+ * Copyright 2024 https://dejvokep.dev/
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

src/main/java/dev/dejvokep/boostedyaml/route/RouteFactory.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2022 https://dejvokep.dev/
+ * Copyright 2024 https://dejvokep.dev/
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

src/main/java/dev/dejvokep/boostedyaml/route/implementation/MultiKeyRoute.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2022 https://dejvokep.dev/
+ * Copyright 2024 https://dejvokep.dev/
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

src/main/java/dev/dejvokep/boostedyaml/route/implementation/SingleKeyRoute.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2022 https://dejvokep.dev/
+ * Copyright 2024 https://dejvokep.dev/
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

src/main/java/dev/dejvokep/boostedyaml/serialization/YamlSerializer.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2022 https://dejvokep.dev/
+ * Copyright 2024 https://dejvokep.dev/
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

src/main/java/dev/dejvokep/boostedyaml/serialization/standard/StandardSerializer.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2022 https://dejvokep.dev/
+ * Copyright 2024 https://dejvokep.dev/
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

src/main/java/dev/dejvokep/boostedyaml/serialization/standard/TypeAdapter.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2022 https://dejvokep.dev/
+ * Copyright 2024 https://dejvokep.dev/
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

src/main/java/dev/dejvokep/boostedyaml/settings/Settings.java

@@ -0,0 +1,26 @@
+/*
+ * Copyright 2024 https://dejvokep.dev/
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package dev.dejvokep.boostedyaml.settings;
+
+/**
+ * A marker interface implemented by all settings defined by the library.
+ * <p>
+ * Should you create custom settings implementations, always extend existing implementations of this class defined by
+ * the library, as objects not implementing any of these will be rejected by
+ * {@link dev.dejvokep.boostedyaml.YamlDocument} methods.
+ */
+public interface Settings {
+}

src/main/java/dev/dejvokep/boostedyaml/settings/dumper/DumperSettings.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2022 https://dejvokep.dev/
+ * Copyright 2024 https://dejvokep.dev/
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -15,6 +15,7 @@
  */
 package dev.dejvokep.boostedyaml.settings.dumper;
 
+import dev.dejvokep.boostedyaml.settings.Settings;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 import org.snakeyaml.engine.v2.api.DumpSettings;
@@ -39,7 +40,7 @@
  * <code>DumperSettings.builder() //configure// .build()</code>
  */
 @SuppressWarnings({"unused", "UnusedReturnValue"})
-public class DumperSettings {
+public class DumperSettings implements Settings {
 
     /**
      * Represents supported encoding. Please learn more <a

src/main/java/dev/dejvokep/boostedyaml/settings/general/GeneralSettings.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2022 https://dejvokep.dev/
+ * Copyright 2024 https://dejvokep.dev/
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -20,6 +20,7 @@
 import dev.dejvokep.boostedyaml.route.Route;
 import dev.dejvokep.boostedyaml.serialization.YamlSerializer;
 import dev.dejvokep.boostedyaml.serialization.standard.StandardSerializer;
+import dev.dejvokep.boostedyaml.settings.Settings;
 import dev.dejvokep.boostedyaml.utils.supplier.ListSupplier;
 import dev.dejvokep.boostedyaml.utils.supplier.MapSupplier;
 import dev.dejvokep.boostedyaml.utils.supplier.SetSupplier;
@@ -36,7 +37,7 @@
  * <code>GeneralSettings.builder() //configure// .build()</code>
  */
 @SuppressWarnings("unused")
-public class GeneralSettings {
+public class GeneralSettings implements Settings {
 
     /**
      * Key format for sections to use; specifies how the loaded/supplied keys should be formatted.

src/main/java/dev/dejvokep/boostedyaml/settings/loader/LoaderSettings.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2022 https://dejvokep.dev/
+ * Copyright 2024 https://dejvokep.dev/
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -16,6 +16,7 @@
 package dev.dejvokep.boostedyaml.settings.loader;
 
 import dev.dejvokep.boostedyaml.YamlDocument;
+import dev.dejvokep.boostedyaml.settings.Settings;
 import dev.dejvokep.boostedyaml.settings.dumper.DumperSettings;
 import dev.dejvokep.boostedyaml.settings.general.GeneralSettings;
 import dev.dejvokep.boostedyaml.settings.updater.UpdaterSettings;
@@ -39,7 +40,7 @@
  * <code>LoaderSettings.builder() //configure// .build()</code>
  */
 @SuppressWarnings({"unused", "UnusedReturnValue"})
-public class LoaderSettings {
+public class LoaderSettings implements Settings {
 
     /**
      * Default loader settings.

src/main/java/dev/dejvokep/boostedyaml/settings/updater/MergeRule.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2022 https://dejvokep.dev/
+ * Copyright 2024 https://dejvokep.dev/
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

src/main/java/dev/dejvokep/boostedyaml/settings/updater/UpdaterSettings.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2022 https://dejvokep.dev/
+ * Copyright 2024 https://dejvokep.dev/
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -22,6 +22,7 @@
 import dev.dejvokep.boostedyaml.dvs.versioning.Versioning;
 import dev.dejvokep.boostedyaml.route.Route;
 import dev.dejvokep.boostedyaml.route.RouteFactory;
+import dev.dejvokep.boostedyaml.settings.Settings;
 import dev.dejvokep.boostedyaml.settings.general.GeneralSettings;
 import dev.dejvokep.boostedyaml.settings.loader.LoaderSettings;
 import dev.dejvokep.boostedyaml.utils.supplier.MapSupplier;
@@ -39,7 +40,7 @@
  * <code>UpdaterSettings.builder() //configure// .build()</code>
  */
 @SuppressWarnings("unused")
-public class UpdaterSettings {
+public class UpdaterSettings implements Settings {
 
     /**
      * Enum defining how options in sections should be sorted during merging.

src/main/java/dev/dejvokep/boostedyaml/settings/updater/ValueMapper.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2022 https://dejvokep.dev/
+ * Copyright 2024 https://dejvokep.dev/
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

src/main/java/dev/dejvokep/boostedyaml/updater/Updater.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2022 https://dejvokep.dev/
+ * Copyright 2024 https://dejvokep.dev/
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

src/main/java/dev/dejvokep/boostedyaml/updater/VersionedOperations.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2022 https://dejvokep.dev/
+ * Copyright 2024 https://dejvokep.dev/
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

src/main/java/dev/dejvokep/boostedyaml/updater/operators/Mapper.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2022 https://dejvokep.dev/
+ * Copyright 2024 https://dejvokep.dev/
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

src/main/java/dev/dejvokep/boostedyaml/updater/operators/Merger.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2022 https://dejvokep.dev/
+ * Copyright 2024 https://dejvokep.dev/
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

src/main/java/dev/dejvokep/boostedyaml/updater/operators/Relocator.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2022 https://dejvokep.dev/
+ * Copyright 2024 https://dejvokep.dev/
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

src/main/java/dev/dejvokep/boostedyaml/utils/conversion/ListConversions.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2022 https://dejvokep.dev/
+ * Copyright 2024 https://dejvokep.dev/
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

src/main/java/dev/dejvokep/boostedyaml/utils/conversion/PrimitiveConversions.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2022 https://dejvokep.dev/
+ * Copyright 2024 https://dejvokep.dev/
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

src/main/java/dev/dejvokep/boostedyaml/utils/supplier/ListSupplier.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2022 https://dejvokep.dev/
+ * Copyright 2024 https://dejvokep.dev/
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.