update for changes

Author: zml2008

buildSrc/src/main/kotlin/org/spongepowered/configurate/build/component.gradle.kts

@@ -179,7 +179,7 @@ sourceSets.configureEach set@{
                 )
                 "cpd"(
                     "encoding" to "UTF-8",
-                    "minimumtokencount" to 105,
+                    "minimumtokencount" to 121,
                     "outputFile" to outputFile.get().asFile,
                     "skipLexicalErrors" to true
                 ) {

format/yaml/src/main/java/org/spongepowered/configurate/yaml/ScalarStyle.java

@@ -24,24 +24,50 @@
 
 /**
  * Style that can be used to represent a scalar.
+ *
+ * @since 4.1.0
  */
 public enum ScalarStyle {
 
     /**
      * A double-quoted string.
      *
      * <p><pre>"hello world"</pre></p>
+     *
+     * @since 4.1.0
      */
     DOUBLE_QUOTED(DumperOptions.ScalarStyle.DOUBLE_QUOTED),
 
     /**
      * A single-quoted string.
      *
      * <p><pre>'hello world'</pre></p>
+     *
+     * @since 4.1.0
      */
     SINGLE_QUOTED(DumperOptions.ScalarStyle.SINGLE_QUOTED),
+
+    /**
+     * String without any quotation.
+     *
+     * <p>This may be ambiguous with non-string types.</p>
+     *
+     * @since 4.1.0
+     */
     UNQUOTED(DumperOptions.ScalarStyle.PLAIN),
+
+    /**
+     * Folded scalar.
+     *
+     * @since 4.1.0
+     */
     FOLDED(DumperOptions.ScalarStyle.FOLDED),
+
+    /**
+     * Literal scalar.
+     *
+     * @since 4.1.0
+     */
     LITERAL(DumperOptions.ScalarStyle.LITERAL)
     ;
 

format/yaml/src/main/java/org/spongepowered/configurate/yaml/Tag.java

@@ -27,6 +27,7 @@
  * A YAML 1.1/1.2 tag
  *
  * @apiNote Design based on §3.2.1.1 of the YAML 1.1 spec
+ * @since 4.1.0
  */
 @AutoValue
 public abstract class Tag {
@@ -35,6 +36,7 @@ public abstract class Tag {
      * Create a new builder for a {@link Tag}.
      *
      * @return a new builder
+     * @since 4.1.0
      */
     public static Tag.Builder builder() {
         return new AutoValue_Tag.Builder();
@@ -47,13 +49,15 @@ public static Tag.Builder builder() {
      * The canonical tag URI.
      *
      * @return tag uri, with `tag:` schema
+     * @since 4.1.0
      */
     public abstract URI uri();
 
     /**
      * The native type that maps to this tag.
      *
      * @return native type for tag
+     * @since 4.1.0
      */
     public abstract Type nativeType();
 
@@ -62,20 +66,24 @@ public static Tag.Builder builder() {
      *
      * @return match pattern
      * @apiNote See §3.3.2 of YAML 1.1 spec
+     * @since 4.1.0
      */
     public abstract Pattern targetPattern();
 
     /**
      * Whether this tag is a global tag with a full namespace or a local one.
      *
      * @return if this is a global tag
+     * @since 4.1.0
      */
     public final boolean global() {
         return uri().getScheme().equals("tag");
     }
 
     /**
      * A builder for {@link Tag Tags}.
+     *
+     * @since 4.1.0
      */
     @AutoValue.Builder
     public abstract static class Builder {
@@ -85,6 +93,7 @@ public abstract static class Builder {
          *
          * @param url canonical tag URI
          * @return this builder
+         * @since 4.1.0
          */
         public abstract Builder uri(URI url);
 
@@ -94,6 +103,7 @@ public abstract static class Builder {
          *
          * @param tagUrl canonical tag URI
          * @return this builder
+         * @since 4.1.0
          */
         public final Builder uri(final String tagUrl) {
             try {
@@ -113,6 +123,7 @@ public final Builder uri(final String tagUrl) {
          *
          * @param type type for the value
          * @return this builder
+         * @since 4.1.0
          */
         public abstract Builder nativeType(Type type);
 
@@ -122,13 +133,15 @@ public final Builder uri(final String tagUrl) {
          *
          * @param targetPattern pattern to match
          * @return this builder
+         * @since 4.1.0
          */
         public abstract Builder targetPattern(Pattern targetPattern);
 
         /**
          * Create a new tag from the provided parameters.
          *
          * @return a new tag
+         * @since 4.1.0
          */
         public abstract Tag build();
 

format/yaml/src/main/java/org/spongepowered/configurate/yaml/TagRepository.java

@@ -26,6 +26,8 @@
 
 /**
  * A collection of tags that are understood when reading a document.
+ *
+ * @since 4.1.0
  */
 public final class TagRepository {
 
@@ -38,6 +40,7 @@ public final class TagRepository {
      *
      * @param tags known tags
      * @return new tag repository
+     * @since 4.1.0
      */
     public static TagRepository of(final List<Tag> tags) {
         return new TagRepository(UnmodifiableCollections.copyOf(tags));
@@ -62,6 +65,7 @@ public static TagRepository of(final List<Tag> tags) {
      *
      * @param scalar scalar to test
      * @return the first matching tag
+     * @since 4.1.0
      */
     public @Nullable Tag forInput(final String scalar) {
         for (final Tag tag : this.tags) {

format/yaml/src/main/java/org/spongepowered/configurate/yaml/Yaml11Tags.java

@@ -24,6 +24,8 @@
 /**
  * Standard types defined on the <a href="https://yaml.org/type/">yaml.org
  * tag repository</a>.
+ *
+ * @since 4.1.0
  */
 public final class Yaml11Tags {
 
@@ -38,6 +40,7 @@ private static String yamlOrg(final String specific) {
      * A binary data tag.
      *
      * @see <a href="https://yaml.org/type/binary.html">tag:yaml.org,2002:binary</a>
+     * @since 4.1.0
      */
     public static final Tag BINARY = Tag.builder()
             .uri(yamlOrg("binary"))
@@ -52,6 +55,7 @@ private static String yamlOrg(final String specific) {
      *     will only support true|false, we will treat those as the default
      *     output format.
      * @see <a href="https://yaml.org/type/bool.html">tag:yaml.org,2002:bool</a>
+     * @since 4.1.0
      */
     public static final Tag BOOL = Tag.builder()
             .uri(yamlOrg("bool"))
@@ -65,6 +69,7 @@ private static String yamlOrg(final String specific) {
      * A floating-point number.
      *
      * @see <a href="https://yaml.org/type/float.html">tag:yaml.org,2002:float</a>
+     * @since 4.1.0
      */
     public static final Tag FLOAT = Tag.builder()
             .uri(yamlOrg("float"))
@@ -79,6 +84,7 @@ private static String yamlOrg(final String specific) {
      * An integer.
      *
      * @see <a href="https://yaml.org/type/int.html">tag:yaml.org,2002:int</a>
+     * @since 4.1.0
      */
     public static final Tag INT = Tag.builder()
             .uri(yamlOrg("int"))
@@ -97,6 +103,7 @@ private static String yamlOrg(final String specific) {
      * are fully implemented.</p>
      *
      * @see <a href="https://yaml.org/type/merge.html">tag:yaml.org,2002:merge</a>
+     * @since 4.1.0
      */
     public static final Tag MERGE = Tag.builder()
             .uri(yamlOrg("merge"))
@@ -112,6 +119,7 @@ private static String yamlOrg(final String specific) {
      * likely never be encountered in an in-memory representation.</p>
      *
      * @see <a href="https://yaml.org/type/null.html">tag:yaml.org,2002:null</a>
+     * @since 4.1.0
      */
     public static final Tag NULL = Tag.builder()
             .uri(yamlOrg("null"))
@@ -125,6 +133,7 @@ private static String yamlOrg(final String specific) {
      * Any string.
      *
      * @see <a href="https://yaml.org/type/str.html">tag:yaml.org,2002:str</a>
+     * @since 4.1.0
      */
     public static final Tag STR = Tag.builder()
             .uri(yamlOrg("str"))
@@ -136,6 +145,7 @@ private static String yamlOrg(final String specific) {
      * A timestamp, containing date, time, and timezone.
      *
      * @see <a href="https://yaml.org/type/timestamp.html">tag:yaml.org,2002:timestamp</a>
+     * @since 4.1.0
      */
     public static final Tag TIMESTAMP = Tag.builder()
             .uri(yamlOrg("timestamp"))

format/yaml/src/test/java/org/spongepowered/configurate/yaml/CommentTest.java

@@ -33,8 +33,8 @@ void testLoadScalarComment() {
                 + "\"i'm a string\""
         );
 
-        assertEquals("Hello world", node.getComment());
-        assertEquals("i'm a string", node.getValue());
+        assertEquals("Hello world", node.comment());
+        assertEquals("i'm a string", node.raw());
     }
 
     @Test
@@ -45,8 +45,8 @@ void testLoadBlockMappingComment() {
                     + "    cat: purrs\n"
         );
 
-        assertEquals("purrs", node.getNode("test", "cat").getValue());
-        assertEquals("meow", node.getNode("test", "cat").getComment());
+        assertEquals("purrs", node.node("test", "cat").raw());
+        assertEquals("meow", node.node("test", "cat").comment());
     }
 
     @Test
@@ -60,9 +60,9 @@ void testLoadBlockScalarSequenceComment() {
                     + "- fourth\n"
         );
 
-        assertNull(test.getNode(0).getComment());
-        assertEquals("i matter less", test.getNode(1).getComment());
-        assertEquals("we skipped one", test.getNode(3).getComment());
+        assertNull(test.node(0).comment());
+        assertEquals("i matter less", test.node(1).comment());
+        assertEquals("we skipped one", test.node(3).comment());
     }
 
     @Test
@@ -77,11 +77,11 @@ void testLoadScalarCommentsInBlockMapping() {
                         + "  test2: goodbye\n"
         );
 
-        final CommentedConfigurationNode child = test.getNode("blah", 0);
-        assertFalse(child.isVirtual());
-        assertEquals("beginning sequence", child.getComment());
-        assertEquals("first on map entry", child.getNode("test").getComment());
-        assertEquals("on second mapping", child.getNode("test2").getComment());
+        final CommentedConfigurationNode child = test.node("blah", 0);
+        assertFalse(child.virtual());
+        assertEquals("beginning sequence", child.comment());
+        assertEquals("first on map entry", child.node("test").comment());
+        assertEquals("on second mapping", child.node("test2").comment());
     }
 
     // flow collections are a bit trickier
@@ -99,9 +99,9 @@ void testLoadCommentInFlowMapping() {
                         + "}\n"
         );
 
-        assertEquals("hello", test.getNode("test").getComment());
-        assertNull(test.getNode("uncommented").getComment());
-        assertEquals("hi there", test.getNode("last").getComment());
+        assertEquals("hello", test.node("test").comment());
+        assertNull(test.node("uncommented").comment());
+        assertEquals("hi there", test.node("last").comment());
     }
 
     @Test
@@ -116,9 +116,9 @@ void testLoadCommentInFlowSequence() {
                         + "]"
         );
 
-        assertEquals("on list", test.getComment());
-        assertEquals("first", test.getNode(0).getComment());
-        assertEquals("second", test.getNode(1).getComment());
+        assertEquals("on list", test.comment());
+        assertEquals("first", test.node(0).comment());
+        assertEquals("second", test.node(1).comment());
     }
 
     @Test
@@ -130,8 +130,8 @@ void testLoadMixedStructure() {
     @Test
     void testWriteScalarCommented() {
         final CommentedConfigurationNode node = CommentedConfigurationNode.root()
-                .setValue("test")
-                .setComment("i have a comment");
+                .raw("test")
+                .comment("i have a comment");
 
         assertEquals(
                 "# i have a comment\n"

format/yaml/src/test/java/org/spongepowered/configurate/yaml/YamlConfigurationLoaderTest.java

@@ -29,8 +29,8 @@
 
 import java.io.BufferedReader;
 import java.io.BufferedWriter;
-import java.io.InputStreamReader;
 import java.io.IOException;
+import java.io.InputStreamReader;
 import java.io.StringWriter;
 import java.net.URL;
 import java.nio.charset.StandardCharsets;

format/yaml/src/test/java/org/spongepowered/configurate/yaml/YamlParserTest.java

@@ -16,7 +16,6 @@
  */
 package org.spongepowered.configurate.yaml;
 
-import static org.junit.jupiter.api.Assertions.assertNotNull;
 import static org.junit.jupiter.api.Assertions.assertNull;
 import static org.junit.jupiter.api.Assertions.assertThrows;
 import static org.junit.jupiter.api.Assertions.assertTrue;
@@ -31,8 +30,8 @@ public class YamlParserTest implements YamlTest {
     @Test
     void testEmptyDocument() throws IOException {
         final ConfigurationNode result = parseString("");
-        assertTrue(result.isEmpty());
-        assertNull(result.getValue());
+        assertTrue(result.empty());
+        assertNull(result.raw());
     }
 
     @Test

format/yaml/src/test/java/org/spongepowered/configurate/yaml/YamlTest.java

@@ -67,14 +67,13 @@ default String dump(final CommentedConfigurationNode input, final @Nullable Node
         final StringWriter writer = new StringWriter();
         try {
             YamlConfigurationLoader.builder()
-                    .setSink(() -> new BufferedWriter(writer))
-                    .setNodeStyle(preferredStyle)
+                    .sink(() -> new BufferedWriter(writer))
+                    .nodeStyle(preferredStyle)
                     .build().save(input);
         } catch (IOException e) {
             fail(e);
         }
         return writer.toString();
     }
 
-
 }