updated encoding options, added docs

Author: petesramek

src/PolylineAlgorithm.Abstraction/IPolylineEncodingOptionsBuilder.cs

@@ -0,0 +1,9 @@
+namespace PolylineAlgorithm.Abstraction;
+
+using PolylineAlgorithm.Abstraction.Validation.Abstraction;
+
+public interface IPolylineEncodingOptionsBuilder<TCoordinate> {
+    IPolylineEncodingOptionsBuilder<TCoordinate> WithBufferSize(int maxBufferSize);
+    IPolylineEncodingOptionsBuilder<TCoordinate> WithValidator(Validator<TCoordinate> validator);
+    PolylineEncodingOptions<TCoordinate> Build();
+}

src/PolylineAlgorithm.Abstraction/PolylineEncodingOptions.cs

@@ -5,7 +5,6 @@
 
 namespace PolylineAlgorithm.Abstraction;
 
-using PolylineAlgorithm.Abstraction.Validation;
 using PolylineAlgorithm.Abstraction.Validation.Abstraction;
 
 /// <summary>
@@ -16,16 +15,16 @@ public class PolylineEncodingOptions<TCoordinate> {
     /// <summary>
     /// Gets the maximum buffer size for encoding operations.
     /// </summary>
-    public int MaxBufferSize { get; } = 64_000;
+    public int BufferSize { get; internal set; }
 
     /// <summary>
     /// Gets the maximum number of characters that can be used in the encoding buffer.
     /// </summary>
     /// <returns>The maximum character count based on the buffer size.</returns>
-    public int MaxCharCount => MaxBufferSize / sizeof(char);
+    public int MaxCharCount => BufferSize / sizeof(char);
 
     /// <summary>
     /// Gets the validator used to validate coordinates, latitude, and longitude values.
     /// </summary>
-    public Validator<TCoordinate> Validator { get; } = new NullValidator<TCoordinate>();
+    public Validator<TCoordinate> Validator { get; internal set; }
 }

src/PolylineAlgorithm.Abstraction/PolylineEncodingOptionsBuilder.cs

@@ -0,0 +1,20 @@
+//
+// Copyright © Pete Sramek. All rights reserved.
+// Licensed under the MIT License. See LICENSE file in the project root for full license information.
+//
+
+namespace PolylineAlgorithm.Abstraction;
+
+/// <summary>
+/// Provides a static factory for creating <see cref="IPolylineEncodingOptionsBuilder{TCoordinate}"/> instances.
+/// </summary>
+public class PolylineEncodingOptionsBuilder {
+    /// <summary>
+    /// Creates a new <see cref="IPolylineEncodingOptionsBuilder{TCoordinate}"/> instance for the specified coordinate type.
+    /// </summary>
+    /// <typeparam name="TCoordinate">The type representing a coordinate.</typeparam>
+    /// <returns>An <see cref="IPolylineEncodingOptionsBuilder{TCoordinate}"/> instance for configuring polyline encoding options.</returns>
+    public static IPolylineEncodingOptionsBuilder<TCoordinate> Create<TCoordinate>() {
+        return new PolylineEncodingOptionsBuilder<TCoordinate>();
+    }
+}

src/PolylineAlgorithm.Abstraction/PolylineEncodingOptionsBuilder`1.cs

@@ -0,0 +1,54 @@
+//
+// Copyright © Pete Sramek. All rights reserved.
+// Licensed under the MIT License. See LICENSE file in the project root for full license information.
+//
+
+namespace PolylineAlgorithm.Abstraction;
+
+using PolylineAlgorithm.Abstraction.Validation;
+using PolylineAlgorithm.Abstraction.Validation.Abstraction;
+using System;
+
+/// <summary>
+/// Provides a builder for configuring <see cref="PolylineEncodingOptions{TCoordinate}"/> instances.
+/// </summary>
+/// <typeparam name="TCoordinate">The type representing a coordinate.</typeparam>
+internal class PolylineEncodingOptionsBuilder<TCoordinate> : IPolylineEncodingOptionsBuilder<TCoordinate> {
+    private int _bufferSize = 64_000;
+    private Validator<TCoordinate> _validator = new NullValidator<TCoordinate>();
+
+    /// <summary>
+    /// Builds a new <see cref="PolylineEncodingOptions{TCoordinate}"/> instance using the configured options.
+    /// </summary>
+    /// <returns>A configured <see cref="PolylineEncodingOptions{TCoordinate}"/> instance.</returns>
+    PolylineEncodingOptions<TCoordinate> IPolylineEncodingOptionsBuilder<TCoordinate>.Build() {
+        return new PolylineEncodingOptions<TCoordinate> {
+            BufferSize = _bufferSize,
+            Validator = _validator
+        };
+    }
+
+    /// <summary>
+    /// Sets the buffer size for encoding operations.
+    /// </summary>
+    /// <param name="maxBufferSize">The maximum buffer size. Must be greater than 11.</param>
+    /// <returns>The current builder instance.</returns>
+    /// <exception cref="ArgumentOutOfRangeException">Thrown if <paramref name="maxBufferSize"/> is less than or equal to 11.</exception>
+    IPolylineEncodingOptionsBuilder<TCoordinate> IPolylineEncodingOptionsBuilder<TCoordinate>.WithBufferSize(int maxBufferSize) {
+        _bufferSize = maxBufferSize > 11 ? maxBufferSize : throw new ArgumentOutOfRangeException(nameof(maxBufferSize), "Buffer size must be greater than 11.");
+
+        return this;
+    }
+
+    /// <summary>
+    /// Sets the validator to use for coordinate validation.
+    /// </summary>
+    /// <param name="validator">The validator instance to use.</param>
+    /// <returns>The current builder instance.</returns>
+    /// <exception cref="ArgumentNullException">Thrown if <paramref name="validator"/> is <c>null</c>.</exception>
+    IPolylineEncodingOptionsBuilder<TCoordinate> IPolylineEncodingOptionsBuilder<TCoordinate>.WithValidator(Validator<TCoordinate> validator) {
+        _validator = validator ?? throw new ArgumentNullException(nameof(validator));
+
+        return this;
+    }
+}