org.hibernate.validator.spi.group.DefaultGroupSequenceProvider Maven / Gradle / Ivy
/*
* Hibernate Validator, declare and validate application constraints
*
* License: Apache License, Version 2.0
* See the license.txt file in the root directory or .
*/
package org.hibernate.validator.spi.group;
import java.util.List;
/**
* This class defines the dynamic group sequence provider contract.
*
* In order to redefine dynamically the default group sequence for a type T, the {@link org.hibernate.validator.group.GroupSequenceProvider} annotation
* must be placed on T, specifying as its value a concrete implementation of {@code DefaultGroupSequenceProvider}, which
* must be parametrized with the type T.
*
*
* If during the validation process the {@code Default} group is validated for T, the actual validated instance
* is passed to the {@code DefaultGroupSequenceProvider} to determine the default group sequence.
*
*
* Note:
*
* - Implementations must provide a public default constructor.
* - Implementations must be thread-safe.
*
*
* @param The type for which an implementation is defined.
*
* @author Kevin Pollet <[email protected]> (C) 2011 SERLI
* @author Hardy Ferentschik
*/
public interface DefaultGroupSequenceProvider {
/**
* This method returns the default group sequence for the given instance.
*
* The object parameter allows to dynamically compose the default group sequence in function of the validated value state.
*
*
* @param object the instance being validated. This value can be {@code null} in case this method was called as part of
* {@linkplain javax.validation.Validator#validateValue(Class, String, Object, Class[]) Validator#validateValue}.
*
* @return a list of classes specifying the default group sequence. The same constraints to the redefined group list
* apply as for lists defined via {@code GroupSequence}. In particular the list has to contain the type T.
*/
List> getValidationGroups(T object);
}