com.lotaris.jee.validation.preprocessing.IPreprocessingConfig Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jee-validation Show documentation

This library offers components that facilitate validation of arbitrary objects and how they are serialized towards a client. It focuses on the wiring of the proposed patterns and does not contain any concrete validator implementations.

There is a newer version: 0.5.2

Show newest version

package com.lotaris.jee.validation.preprocessing;

import com.lotaris.jee.validation.IPatchObject;
import com.lotaris.jee.validation.IValidationContext;
import com.lotaris.jee.validation.IValidator;
import java.util.List;
import javax.validation.groups.Default;

/**
 * Shared configuration for preprocessors.
 *
 * @author Simon Oulevay ([email protected])
 */
public interface IPreprocessingConfig {

	/**
	 * Returns the context used for validation.
	 *
	 * @return a validation context
	 */
	IValidationContext getValidationContext();

	/**
	 * Returns the group or list of groups targeted for validation. An empty list is equivalent to
	 * the {@link Default} group. This is used by the validation preprocessor.
	 *
	 * @return a list of validation groups (must not be null)
	 * @see BeanValidationPreprocessor
	 */
	Class[] getValidationGroups();

	/**
	 * Returns a list of additional validators to apply to the preprocessed object.
	 *
	 * @return a list of validators
	 * @see ValidationPreprocessor
	 */
	List getValidators();

	/**
	 * Whether patch validation should be used. Patch validation will only accept an
	 * {@link IPatchObject} that defines which of its properties were explicitly set. Only those
	 * properties will be validated.
	 *
	 * @return true if patch validation is enabled
	 * @see BeanValidationPreprocessor
	 */
	boolean isPatchValidationEnabled();
}