com.github.jinahya.assertj.validation.ValidationAssert Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of assertj-bean-validation Show documentation
An AssertJ extension for Bean-Validation
The 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 2012-2021 the original author or authors.
 */
package com.github.jinahya.assertj.validation;

/*-
 * #%L
 * assertj-bean-validation
 * %%
 * Copyright (C) 2021 Jinahya, Inc.
 * %%
 * 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.
 * #L%
 */

import org.assertj.core.api.Assert;

import javax.validation.Validator;
import java.util.Optional;
import java.util.function.Supplier;

/**
 * A base interface for verifying values and beans.
 *
 * @param    self type parameter
 * @param  actual type parameter
 * @author Jin Kwon <onacit_at_gmail.com>
 */
public interface ValidationAssert, ACTUAL>
        extends Assert {

    /**
     * Configures this assertion object to use specified groups targeted for validation.
     *
     * @param groups the validation groups to use; {@code null} or empty for clearing the group.
     * @return this assertion object.
     */
    SELF targetingGroups(final Class... groups);

    /**
     * Configures this assertion object to use specified validator.
     *
     * @param validator the validator to use; {@code null} to reset.
     * @return this assertion object.
     */
    default SELF usingValidator(final Validator validator) {
        return usingValidatorSuppliedBy(
                Optional.ofNullable(validator)
                        .>map(v -> () -> v)
                        .orElse(null)
        );
    }

    /**
     * Configures this assertion object to use validators supplied by specified supplier.
     *
     * @param validatorSupplier the supplier supplying validators; {@code null} to reset.
     * @return this assertion object.
     */
    SELF usingValidatorSuppliedBy(final Supplier validatorSupplier);
}