All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.assertj.vavr.api.ValidationShouldContain Maven / Gradle / Ivy

There is a newer version: 0.4.3
Show newest version
/*
 * 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.
 *
 * Copyright 2017-2021 the original author or authors.
 */
package org.assertj.vavr.api;

import io.vavr.control.Validation;
import org.assertj.core.error.BasicErrorMessageFactory;

/**
 * Build error message when an {@link Validation} should contain a specific value.
 *
 * @author Michał Chmielarz
 */
class ValidationShouldContain extends BasicErrorMessageFactory {

    private static final String EXPECTING_TO_CONTAIN = "%nExpecting:%n  <%s>%nto contain:%n  <%s>%nbut did not.";
    private static final String EXPECTING_TO_CONTAIN_SAME = "%nExpecting:%n  <%s>%nto contain the instance (i.e. compared with ==):%n  <%s>%nbut did not.";
    private static final String EXPECTING_TO_CONTAIN_BUT_IS_INVALID = "%nExpecting:%n  <%s>%nto contain valid value:%n  <%s>%nbut was invalid.";
    private static final String EXPECTING_TO_CONTAIN_BUT_IS_VALID = "%nExpecting:%n  <%s>%nto contain invalid value:%n  <%s>%nbut was valid.";

    private ValidationShouldContain(String message, Object actual, Object expected) {
        super(message, actual, expected);
    }

    private ValidationShouldContain(String format, Object... arguments) {
        super(format, arguments);
    }

    /**
     * Indicates that the provided valid {@link Validation} does not contain the provided argument as value.
     *
     * @param validation    the {@link Validation} which contains a value.
     * @param expectedValue the value we expect to be in the provided in valid {@link Validation}.
     * @param      type of the value in the case of the invalid {@link Validation}.
     * @param        type of the value in the case of the valid {@link Validation}.
     * @return an error message factory
     */
    static  ValidationShouldContain shouldContainValid(Validation validation, VALID expectedValue) {
        return validation.isValid() ?
                new ValidationShouldContain(EXPECTING_TO_CONTAIN, validation, expectedValue) :
                shouldContainButIsInvalid(validation, expectedValue);
    }

    /**
     * Indicates that the provided invalid {@link Validation} does not contain the provided argument as error value.
     *
     * @param validation         the {@link Validation} which contains a value.
     * @param expectedErrorValue the value we expect to be in the provided in invalid {@link Validation}.
     * @param           type of the value in the case of the invalid {@link Validation}.
     * @param             type of the value in the case of the valid {@link Validation}.
     * @return an error message factory
     */
    static  ValidationShouldContain shouldContainInvalid(Validation validation, INVALID expectedErrorValue) {
        return validation.isInvalid() ?
                new ValidationShouldContain(EXPECTING_TO_CONTAIN, validation, expectedErrorValue) :
                shouldContainButIsValid(validation, expectedErrorValue);
    }

    /**
     * Indicates that the provided {@link Validation} does not contain the provided argument (judging by reference
     * equality).
     *
     * @param validation    the {@link Validation} which contains a value.
     * @param expectedValue the value we expect to be in the provided valid {@link Validation}.
     * @param      type of the value in the case of the invalid {@link Validation}.
     * @param        type of the value in the case of the valid {@link Validation}.
     * @return an error message factory
     */
    static  ValidationShouldContain shouldContainValidSame(Validation validation, VALID expectedValue) {
        return validation.isValid() ?
                new ValidationShouldContain(EXPECTING_TO_CONTAIN_SAME, validation, expectedValue) :
                shouldContainButIsInvalid(validation, expectedValue);
    }

    /**
     * Indicates that the provided {@link Validation} does not contain the provided argument (judging by reference
     * equality).
     *
     * @param validation         the {@link Validation} which contains a value.
     * @param expectedErrorValue the value we expect to be in the provided invalid {@link Validation}.
     * @param           type of the value in the case of the invalid {@link Validation}.
     * @param             type of the value in the case of the valid {@link Validation}.
     * @return an error message factory
     */
    static  ValidationShouldContain shouldContainInvalidSame(Validation validation, VALID expectedErrorValue) {
        return validation.isInvalid() ?
                new ValidationShouldContain(EXPECTING_TO_CONTAIN_SAME, validation, expectedErrorValue) :
                shouldContainButIsValid(validation, expectedErrorValue);
    }

    /**
     * Indicates that an {@link Validation} is invalid so it doesn't contain the expected valid value.
     *
     * @param validation         the {@link Validation} which contains a value.
     * @param expectedValidValue the valid value we expect to be in an {@link Validation}.
     * @return an error message factory.
     */
    static ValidationShouldContain shouldContainButIsInvalid(Validation validation, Object expectedValidValue) {
        return new ValidationShouldContain(EXPECTING_TO_CONTAIN_BUT_IS_INVALID, validation, expectedValidValue);
    }

    /**
     * Indicates that an {@link Validation} is valid so it doesn't contain the expected error value.
     *
     * @param validation         the {@link Validation} which contains a value.
     * @param expectedErrorValue the error value we expect to be in an {@link Validation}.
     * @return an error message factory.
     */
    static ValidationShouldContain shouldContainButIsValid(Validation validation, Object expectedErrorValue) {
        return new ValidationShouldContain(EXPECTING_TO_CONTAIN_BUT_IS_VALID, validation, expectedErrorValue);
    }
}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy