com.github.jinahya.assertj.validation.PropertyAssert Maven / Gradle / Ivy
Show all versions of assertj-bean-validation Show documentation
package com.github.jinahya.assertj.validation;
/*-
* #%L
* assertj-bean-validation-javax
* %%
* Copyright (C) 2021 - 2022 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 javax.validation.ConstraintViolation;
import java.util.Set;
import java.util.function.Consumer;
/**
* An interface for verifying a value against a specific property of a specific bean type.
*
* @param self type parameter
* @param actual type parameter
* @author Jin Kwon <onacit_at_gmail.com>
*/
public interface PropertyAssert, ACTUAL>
extends ValidationAssert {
/**
* Verifies that the {@code actual} value is valid for the property of specified name of specified bean type, while
* accepting a set of constraint violations, which may be empty, to specified consumer.
*
* @param beanType the bean type; must be not {@code null}.
* @param propertyName the name of the property; must be not {@code null}.
* @param consumer the consumer accepts the set of constraint violations.
* @param type of the object to validate
* @return this assertion object.
* @throws AssertionError when the {@code actual} is not valid for {@code beanType#propertyName}.
* @apiNote Note that the {@link jakarta.validation.Valid @Valid} is not honored by the
* {@link jakarta.validation.Validator#validateValue(Class, String, Object, Class[])} method on which this method
* relies.
* @see #isValidFor(Class, String)
*/
SELF isValidFor(final Class beanType, final String propertyName,
final Consumer>> consumer);
/**
* Verifies that the {@code actual} value is valid for the property of specified name of specified bean type.
*
* {@snippet lang = "java" id = "isValidFor":
* class User {
* @NotBlank String name;
* @Max(0x7F) @PositiveOrZero int age;
* }
*
* // @link region substring="assertThatProperty" target="ValidationAssertions#assertThatProperty(Object)"
* // @highlight region substring="fail" type=highlighted
* assertThatProperty("Jane").isValidFor(User.class, "name"); // should pass
* assertThatProperty( null).isValidFor(User.class, "name"); // should fail // @highlight regex="\-?(null|name)" type=highlighted
* assertThatProperty( "").isValidFor(User.class, "name"); // should fail // @highlight regex='(\"\"|name)' type=highlighted
* assertThatProperty( " ").isValidFor(User.class, "name"); // should fail // @highlight regex='(\"\s\"|name)' type=highlighted
* assertThatProperty( 0).isValidFor(User.class, "age"); // should pass
* assertThatProperty( 28).isValidFor(User.class, "age"); // should pass
* assertThatProperty( -1).isValidFor(User.class, "age"); // should fail // @highlight regex="\-?(\d+|age)" type=highlighted
* assertThatProperty( 300).isValidFor(User.class, "age"); // should fail // @highlight regex="\-?(\d+|age)" type=highlighted
* // @end
* // @end
*}
*
* @param beanType the bean type; must be not {@code null}.
* @param propertyName the name of the property; must be not {@code null}.
* @param type of the object to validate
* @return this assertion object.
* @throws AssertionError when the {@code actual} is not valid for {@code beanType#propertyName}.
* @apiNote Note that the {@link jakarta.validation.Valid @Valid} is not honored by the
* {@link jakarta.validation.Validator#validateValue(Class, String, Object, Class[])} method on which this method
* relies.
* @see #isValidFor(Class, String, Consumer)
*/
default SELF isValidFor(final Class beanType, final String propertyName) {
return isValidFor(
beanType,
propertyName,
s -> {
}
);
}
/**
* Verifies that the {@code actual} value is not valid for the property of specified name of specified bean
* type.
*
* {@snippet lang = "java" id = "isNotValidFor":
* class User {
* @NotBlank String name;
* @Max(0x7F) @PositiveOrZero int age;
* }
*
* // @link region substring="assertThatProperty" target="ValidationAssertions#assertThatProperty(Object)"
* // @highlight region substring="pass" type=highlighted
* assertThatProperty("Jane").isNotValidFor(User.class, "name"); // should fail
* assertThatProperty( null).isNotValidFor(User.class, "name"); // should pass // @highlight regex="\-?(null|name)" type=highlighted
* assertThatProperty( "").isNotValidFor(User.class, "name"); // should pass // @highlight regex='(\"\"|name)' type=highlighted
* assertThatProperty( " ").isNotValidFor(User.class, "name"); // should pass // @highlight regex='(\"\s\"|name)' type=highlighted
* assertThatProperty( 0).isNotValidFor(User.class, "age"); // should fail
* assertThatProperty( 28).isNotValidFor(User.class, "age"); // should fail
* assertThatProperty( -1).isNotValidFor(User.class, "age"); // should pass // @highlight regex="\-?(\d+|age)" type=highlighted
* assertThatProperty( 300).isNotValidFor(User.class, "age"); // should pass // @highlight regex="\-?(\d+|age)" type=highlighted
* // @end
* // @end
*}
*
* @param beanType the bean type; must be not {@code null}.
* @param propertyName the name of the property; must be not {@code null}.
* @param type of the object to validate
* @return this assertion object.
* @throws AssertionError when the {@code actual} is not valid for {@code beanType#propertyName}.
* @apiNote Note that the {@link jakarta.validation.Valid @Valid} is not honored by the
* {@link jakarta.validation.Validator#validateValue(Class, String, Object, Class[])} method on which this method
* relies.
* @see #isValidFor(Class, String, Consumer)
*/
SELF isNotValidFor(final Class beanType, final String propertyName);
}