added javadoc to dtotester

Author: Sabrina Lawrey

src/main/java/net/openhft/chronicle/testframework/dto/DtoTester.java

@@ -11,31 +11,86 @@
 
 import static java.util.Objects.requireNonNull;
 
+/**
+ * DtoTester is an interface for testing Data Transfer Objects (DTOs).
+ * It provides various methods to set up and execute tests that include
+ * accessor checks, validation, mutation, and resetting.
+ */
 public interface DtoTester {
 
+    /**
+     * Executes all the configured tests on the DTO.
+     */
     void test();
 
+    /**
+     * Builds a new DtoTester with the given type and constructor.
+     *
+     * @param type        The class of the DTO.
+     * @param constructor A supplier that constructs instances of the DTO.
+     * @return A builder instance to configure the tester.
+     */
     @NotNull
     static <T> Builder<T> builder(@NotNull final Class<T> type,
                                   @NotNull final Supplier<? extends T> constructor) {
         requireNonNull(type);
-
         return new DtoTesterBuilder<>(type, constructor);
     }
 
+    /**
+     * Builder interface for configuring and building a DtoTester instance.
+     *
+     * @param <T> The type of the DTO.
+     */
     interface Builder<T> {
 
+        /**
+         * Adds accessors to the builder for testing.
+         *
+         * @param getter The getter function.
+         * @param setter The setter function.
+         * @return This builder, for chaining.
+         */
         @NotNull <R> Builder<T> withAccessors(@NotNull Function<? super T, ? extends R> getter,
                                               @NotNull BiConsumer<? super T, ? super R> setter);
 
+        /**
+         * Adds a resetter function to the builder.
+         *
+         * @param resetter The reset function.
+         * @return This builder, for chaining.
+         */
         @NotNull Builder<T> withResetter(@NotNull Consumer<? super T> resetter);
 
+        /**
+         * Adds a validation function to the builder.
+         *
+         * @param validator The validation function.
+         * @return This builder, for chaining.
+         */
         @NotNull Builder<T> withValidator(@NotNull Consumer<? super T> validator);
 
+        /**
+         * Adds a mutator to the builder for testing.
+         *
+         * @param type       The type of the mutator (MANDATORY/OPTIONAL).
+         * @param mutatorName The name of the mutator.
+         * @param mutator    The mutation function.
+         * @return This builder, for chaining.
+         */
         @NotNull <R> Builder<T> addMutator(@NotNull MutatorType type,
                                            @NotNull String mutatorName,
                                            @NotNull Consumer<? super T> mutator);
 
+        /**
+         * Adds a mutator to the builder for testing, with a specified value.
+         *
+         * @param mutatorType The type of the mutator (MANDATORY/OPTIONAL).
+         * @param mutatorName The name of the mutator.
+         * @param setter      The setter function.
+         * @param value       The value to set.
+         * @return This builder, for chaining.
+         */
         default @NotNull <R> Builder<T> addMutator(@NotNull final MutatorType mutatorType,
                                                    @NotNull final String mutatorName,
                                                    @NotNull final BiConsumer<? super T, ? super R> setter,
@@ -46,26 +101,18 @@ interface Builder<T> {
             return addMutator(mutatorType, mutatorName, t -> setter.accept(t, value));
         }
 
-
-        /*
-        @NotNull Builder<T> addValidationRule(@NotNull String ruleName,
-                                              @NotNull Predicate<? super T> validator);
-
-        default @NotNull <R> Builder<T> addValidationRule(@NotNull final String ruleName,
-                                                          @NotNull final Function<? super T, ? extends R> getter,
-                                                          @Nullable final R unexpected) {
-            requireNonNull(ruleName);
-            requireNonNull(getter);
-            return addValidationRule(ruleName, t -> !getter.apply(t).equals(unexpected));
-        }
+        /**
+         * Builds the DtoTester instance.
+         *
+         * @return The built DtoTester.
          */
-
         DtoTester build();
-
     }
 
+    /**
+     * Enum for defining mutator types.
+     */
     enum MutatorType {
         MANDATORY, OPTIONAL;
     }
-
 }

src/main/java/net/openhft/chronicle/testframework/dto/package-info.java

@@ -0,0 +1,10 @@
+/**
+ * Provides interfaces and classes for testing Data Transfer Objects (DTOs) within
+ * the Chronicle Test Framework. This package includes mechanisms for building
+ * and configuring tests that validate and manipulate DTOs, including functionality
+ * for accessing, mutating, resetting, and validating DTOs.
+ *
+ * <p>The main interface provided is {@link net.openhft.chronicle.testframework.dto.DtoTester},
+ * which offers a fluent builder pattern for configuring tests on DTOs.
+ */
+package net.openhft.chronicle.testframework.dto;