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

Go to download

Show more of this group Show more artifacts with this name
Show all versions of assertj-bean-validation-generic Show documentation

An AssertJ extension for Bean-Validation

The newest version!

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 static java.util.Objects.requireNonNull;

/**
 * A class for fluently creating instances of {@link BeanAssert} class.
 *
 * @author Jin Kwon <onacit_at_gmail.com>
 * @see BeanAssert
 */
public final class BeanAssertions {

    /**
     * Creates a new assertion instance for specified bean object.
     *
     * @param actual the bean object to verify.
     * @return a new assertion instance for {@code actual}.
     */
    public static BeanAssert assertThat(final Object actual) {
        return new BeanAssert(actual);
    }

    /**
     * Creates a new assertion instance for the bean object wrapped in specified wrapper.
     *
     * @param wrapper the wrapper wraps the actual bean value; must not be {@code null}.
     * @return a assertion instance for {@link BeanWrapper#getActual()} wrapper.actual}.
     */
    public static BeanAssert assertThat(final BeanWrapper wrapper) {
        return assertThat(requireNonNull(wrapper, "wrapper is null").getActual());
    }

    /**
     * Creates a new assertion instance for specified bean object.
     *
     * @param actual the bean object to verify.
     * @return a new assertion instance for {@code actual}.
     */
    public static BeanAssert assertBean(final Object actual) {
        return assertThat(actual);
    }

    private BeanAssertions() {
        throw new NonInstantiatableAssertionError();
    }
}