diff --git a/.github/workflows/build_mainline.yml b/.github/workflows/build_mainline.yml index aaf1ed4..d290dc5 100644 --- a/.github/workflows/build_mainline.yml +++ b/.github/workflows/build_mainline.yml @@ -16,8 +16,10 @@ jobs: - uses: actions/checkout@v4 with: ref: ${{ github.head_ref }} + token: ${{ secrets.REPO_TOKEN }} fetch-depth: 2 + - name: Set up JDK 21 uses: actions/setup-java@v1 with: diff --git a/src/main/java/be/sddevelopment/validation/Checked.java b/src/main/java/be/sddevelopment/validation/Checked.java index ea364d2..0ec5ad0 100644 --- a/src/main/java/be/sddevelopment/validation/Checked.java +++ b/src/main/java/be/sddevelopment/validation/Checked.java @@ -13,9 +13,10 @@ * The result of said evaluation is represented by a {@link EvaluationRationale}. * The original object is maintained as well, to allow for further processing, and flexibility in dealing with various validation states. * + * Intended as a monadic structure to allow for fluent programming with the result of a validation. + * * @author stijnd * @version 1.0.0-SNAPSHOT - * @apiNote Intended as a monadic structure to allow for fluent programming with the result of a validation. */ public final class Checked { diff --git a/src/main/java/be/sddevelopment/validation/Reason.java b/src/main/java/be/sddevelopment/validation/Reason.java index f9eb769..89faabc 100644 --- a/src/main/java/be/sddevelopment/validation/Reason.java +++ b/src/main/java/be/sddevelopment/validation/Reason.java @@ -8,8 +8,9 @@ * Represents the evaluation of a single {@link ValidationRule}, and will be included in a {@link EvaluationRationale}. * Each reason will tell the user whether a particular rule passed or failed, and will include a description (aka "rationale") to explain why a certain result was achieved. * + * This class is immutable, and provides static factory methods to simplify usage, and increase readability.. + * * @version 1.0.0-SNAPSHOT - * @apiNote This class is immutable, and provides static factory methods to simplify usage, and increase readability.. * @since 1.0.0-SNAPSHOT */ public record Reason(String rationale, Evaluation result) { diff --git a/src/main/java/be/sddevelopment/validation/ValidationRule.java b/src/main/java/be/sddevelopment/validation/ValidationRule.java index 6a1902b..fbe02be 100644 --- a/src/main/java/be/sddevelopment/validation/ValidationRule.java +++ b/src/main/java/be/sddevelopment/validation/ValidationRule.java @@ -6,10 +6,9 @@ *

ValidationRule class.

* Represents a single validation rule, which can be applied to an object of any type. * - * @param rule a method that accepts an object of type and returns a boolean that indicates if it matches the validation criterium. + * @param rule a method that accepts an object of type T and returns a boolean that indicates if it matches the validation criterium. * @param description textual description of the validation rule * @param type of the object onto which the rule can be applied - * @apiNote This class is immutable */ public record ValidationRule(Predicate rule, String description) { }