All Downloads are FREE. Search and download functionalities are using the official Maven repository.

javax.validation.ConstraintValidator Maven / Gradle / Ivy

The newest version!
/*
* 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 javax.validation.constraintvalidation.SupportedValidationTarget;
import java.lang.annotation.Annotation;

/**
 * Defines the logic to validate a given constraint {@code A}
 * for a given object type {@code T}.
 * 

* Implementations must comply to the following restriction: *

    *
  • {@code T} must resolve to a non parameterized type
  • *
  • or generic parameters of {@code T} must be unbounded * wildcard types
  • *
*

* The annotation {@link SupportedValidationTarget} can be put on a * {@code ConstraintValidator} implementation to mark it as supporting * cross-parameter constraints. Check out {@link SupportedValidationTarget} * and {@link Constraint} for more information. * * @author Emmanuel Bernard * @author Hardy Ferentschik */ public interface ConstraintValidator { /** * Initializes the validator in preparation for * {@link #isValid(Object, ConstraintValidatorContext)} calls. * The constraint annotation for a given constraint declaration * is passed. *

* This method is guaranteed to be called before any use of this instance for * validation. * * @param constraintAnnotation annotation instance for a given constraint declaration */ void initialize(A constraintAnnotation); /** * Implements the validation logic. * The state of {@code value} must not be altered. *

* This method can be accessed concurrently, thread-safety must be ensured * by the implementation. * * @param value object to validate * @param context context in which the constraint is evaluated * * @return {@code false} if {@code value} does not pass the constraint */ boolean isValid(T value, ConstraintValidatorContext context); }





© 2015 - 2024 Weber Informatics LLC | Privacy Policy