javax.validation.TraversableResolver Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of swagger-all Show documentation
swagger-all is a rebundled verison of Swagger as one OSGi bundle.
There is a newer version: 1.5.7
/*
* JBoss, Home of Professional Open Source
* Copyright 2009, Red Hat, Inc. and/or its affiliates, and individual contributors
* by the @authors tag. See the copyright.txt in the distribution for a
* full listing of individual contributors.
*
* 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.
*/
package javax.validation;

import java.lang.annotation.ElementType;

import static javax.validation.Path.*;

/**
 * Contract determining if a property can be accessed by the Bean 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 Bean 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 Bean Validator)
	 * @param elementType either {@code FIELD} or {@code METHOD}
	 * @return {@code true} if the Bean 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 Bean 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, javax.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 Bean Validator)
	 * @param elementType either {@code FIELD} or {@code METHOD}
	 * @return {@code true} if the Bean Validation provider is allowed to
	 *         cascade validation, {@code false} otherwise
	 */
	boolean isCascadable(Object traversableObject,
						 Node traversableProperty,
						 Class rootBeanType,
						 Path pathToTraversableObject,
						 ElementType elementType);
}