io.github.theangrydev.businessflows.ValidationPath Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2016 Liam Williams .
 *
 * This file is part of business-flows.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *  http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package io.github.theangrydev.businessflows;


import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;

/**
 * A {@link ValidationPath} is a special kind of {@link HappyPath} that can accumulate several validation failures into
 * a list of {@link Sad}, if there are any failures.
 *
 * {@inheritDoc}
 */
public class ValidationPath extends HappyPath> {

    private ValidationPath(BusinessCase> businessCase) {
        super(businessCase);
    }

    /**
     * Helper method. Alias for {@link #validate(Object, List)}.
     */
    @SafeVarargs
    public static  ValidationPath validate(Happy happy, ActionThatMightFail... validators) {
        return validate(happy, Arrays.asList(validators));
    }

    /**
     * Validate the given {@link Happy} object by running the given list of validators over it.
     * All validators that fail will be accumulated into the list of {@link Sad} results.
     * The first technical failure encountered will result in a technical failure overall.
     *
     * @param happy The {@link Happy} object to validate
     * @param validators Actions that act on the happy object and may indicate a validation failure by returning {@link Sad}
     * @param  The type of happy  object the resulting {@link SadPath} may represent
     * @param  The type of sad object the resulting {@link SadPath} may represent
     * @return The result of applying all the validators
     */
    public static  ValidationPath validate(Happy happy, List> validators) {
        List validationFailures = new ArrayList<>(validators.size());
        for (ActionThatMightFail validator : validators) {
            try {
                validator.attemptHappyPath(happy).ifSad().peek(validationFailures::add);
            } catch (Exception technicalFailure) {
                return technicalFailureDuringValidation(technicalFailure);
            }
        }
        if (validationFailures.isEmpty()) {
            return validationSuccess(happy);
        } else {
            return validationFailed(validationFailures);
        }
    }

    /**
     * Helper method. Alias for {@link #validate(List)}.
     */
    @SafeVarargs
    public final ValidationPath validate(ActionThatMightFail... validators) {
        return validate(Arrays.asList(validators));
    }

    /**
     * Perform a subsequent round of validation, which will take place if the previous one suceeded.
     * This can be useful when you want e.g. expensive validators to run after cheap ones, or if you want to group validators together.
     *
     * @param validators Actions that act on the happy object and may indicate a validation failure by returning {@link Sad}
     * @return The result of applying all the validators
     */
    public ValidationPath validate(List> validators) {
        return join(happy -> validate(happy, validators), ValidationPath::validationFailed, ValidationPath::technicalFailureDuringValidation);
    }

    private static  ValidationPath validationSuccess(Happy happy) {
        return new ValidationPath<>(new HappyCase<>(happy));
    }

    private static  ValidationPath validationFailed(List sad) {
        return new ValidationPath<>(new SadCase<>(sad));
    }

    private static  ValidationPath technicalFailureDuringValidation(Exception technicalFailure) {
        return new ValidationPath<>(new TechnicalFailureCase<>(technicalFailure));
    }
}