ext-heading-anchor: Minor cleanups for consistency

Author: robinst

commonmark-ext-heading-anchor/src/main/java/org/commonmark/ext/heading/anchor/HeadingAnchorExtension.java

@@ -10,8 +10,8 @@
 /**
  * Extension for adding auto generated IDs to headings.
  * <p>
- * Create it with {@link #create()} and then configure it on the builder
- * {@link HtmlRenderer.Builder#extensions(Iterable)}).
+ * Create it with {@link #create()} or {@link #builder()} and then configure it on the
+ * renderer builder ({@link HtmlRenderer.Builder#extensions(Iterable)}).
  * <p>
  * The heading text will be used to create the id. Multiple headings with the
  * same text will result in appending a hyphen and number. For example:
@@ -33,20 +33,22 @@ public class HeadingAnchorExtension implements HtmlRenderer.HtmlRendererExtensio
     private final String idPrefix;
     private final String idSuffix;
 
-    private HeadingAnchorExtension(String defaultId, String idPrefix, String idSuffix) {
-        this.defaultId = defaultId;
-        this.idPrefix = idPrefix;
-        this.idSuffix = idSuffix;
+    private HeadingAnchorExtension(Builder builder) {
+        this.defaultId = builder.defaultId;
+        this.idPrefix = builder.idPrefix;
+        this.idSuffix = builder.idSuffix;
     }
 
+    /**
+     * @return the extension built with default settings
+     */
     public static Extension create() {
-        return create(builder());
-    }
-
-    private static Extension create(Builder builder) {
-        return new HeadingAnchorExtension(builder.defaultId, builder.idPrefix, builder.idSuffix);
+        return new HeadingAnchorExtension(builder());
     }
 
+    /**
+     * @return a builder to configure the extension settings
+     */
     public static Builder builder() {
         return new Builder();
     }
@@ -62,15 +64,9 @@ public AttributeProvider create(AttributeProviderContext context) {
     }
 
     public static class Builder {
-        private String defaultId;
-        private String idPrefix;
-        private String idSuffix;
-
-        public Builder() {
-            defaultId = "id";
-            idPrefix = "";
-            idSuffix = "";
-        }
+        private String defaultId = "id";
+        private String idPrefix = "";
+        private String idSuffix = "";
 
         /**
          * @param value Default value for the id to take if no generated id can be extracted. Default "id"
@@ -92,15 +88,18 @@ public Builder idPrefix(String value) {
 
         /**
          * @param value Set the value to be appended to every id generated. Default ""
-         * @return
+         * @return {@code this}
          */
         public Builder idSuffix(String value) {
             this.idSuffix = value;
             return this;
         }
 
+        /**
+         * @return a configured extension
+         */
         public Extension build() {
-            return HeadingAnchorExtension.create(this);
+            return new HeadingAnchorExtension(this);
         }
     }
 }

commonmark-ext-heading-anchor/src/test/java/org/commonmark/ext/heading/anchor/HeadingAnchorConfigurationTest.java

@@ -1,14 +1,12 @@
 package org.commonmark.ext.heading.anchor;
 
-import java.util.Arrays;
-import java.util.Collections;
-import java.util.Set;
-
 import org.commonmark.Extension;
 import org.commonmark.parser.Parser;
 import org.commonmark.renderer.html.HtmlRenderer;
 import org.junit.Test;
 
+import java.util.Arrays;
+
 import static org.hamcrest.CoreMatchers.equalTo;
 import static org.hamcrest.MatcherAssert.assertThat;