jakarta.validation.TraversableResolver Maven / Gradle / Ivy
/*
* Jakarta Validation API
*
* License: Apache License, Version 2.0
* See the license.txt file in the root directory or .
*/
package jakarta.validation;
import static jakarta.validation.Path.*;
import java.lang.annotation.ElementType;
/**
* Contract determining if a property can be accessed by the Jakarta Validation provider.
* This contract is called for each property that is being either validated or cascaded.
*
* A traversable resolver implementation must be thread-safe.
*
* @author Emmanuel Bernard
*/
public interface TraversableResolver {
/**
* Determines if the Jakarta Validation provider is allowed to reach the property state.
*
* @param traversableObject object hosting {@code traversableProperty}
* or {@code null} if {@code validateValue} is called
* @param traversableProperty the traversable property
* @param rootBeanType type of the root object passed to the Validator
* or hosting the method or constructor validated
* @param pathToTraversableObject path from the root object to
* {@code traversableObject}
* (using the path specification defined by Validation)
* @param elementType either {@code FIELD} or {@code METHOD}
* @return {@code true} if the Jakarta Validation provider is allowed to
* reach the property state, {@code false} otherwise
*/
boolean isReachable(Object traversableObject,
Node traversableProperty,
Class rootBeanType,
Path pathToTraversableObject,
ElementType elementType);
/**
* Determines if the Jakarta Validation provider is allowed to cascade validation on
* the bean instance returned by the property value
* marked as {@code @Valid}.
*
* Note that this method is called only if
* {@link #isReachable(Object, jakarta.validation.Path.Node, Class, Path, java.lang.annotation.ElementType)}
* returns {@code true} for the same set of arguments and if the property
* is marked as {@link Valid}.
*
* @param traversableObject object hosting {@code traversableProperty}
* or {@code null} if {@code validateValue} is called
* @param traversableProperty the traversable property
* @param rootBeanType type of the root object passed to the Validator
* or hosting the method or constructor validated
* @param pathToTraversableObject path from the root object to
* {@code traversableObject}
* (using the path specification defined by Validation)
* @param elementType either {@code FIELD} or {@code METHOD}
* @return {@code true} if the Jakarta Validation provider is allowed to
* cascade validation, {@code false} otherwise
*/
boolean isCascadable(Object traversableObject,
Node traversableProperty,
Class rootBeanType,
Path pathToTraversableObject,
ElementType elementType);
}