org.jarbframework.constraint.validation.DatabaseConstrained Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jarb-constraints Show documentation

Module for handling database constraints

The newest version!

package org.jarbframework.constraint.validation;

import static java.lang.annotation.ElementType.FIELD;
import static java.lang.annotation.ElementType.TYPE;
import static java.lang.annotation.RetentionPolicy.RUNTIME;

import java.lang.annotation.Documented;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;

import javax.validation.Constraint;
import javax.validation.Payload;

@Documented
@Target({ TYPE, FIELD })
@Retention(RUNTIME)
@Constraint(validatedBy = DatabaseConstrainedAdapter.class)
public @interface DatabaseConstrained {
	
    /**
     * Identifier of the DatabaseConstraintValidator bean that should be used
     * for constraint validation. When left blank we attempt to autowire the validator
     * from our context, or build a new default validator instance.
     * @return identifier of the DatabaseConstraintValidator bean 
     */
    String id() default "";
    
    /**
     * Identifier of the ValidatorFactory bean that should be used for message interpolation.
     * @return identifier for the validator factory
     */
    String factory() default "";
    
    /**
     * Identifier BeanMetadataRepository bean that should be used for column metadata retrieval.
     * @return identifier for the BeanMetadataRepository bean
     */
    String beanMetadataRepository() default "";

    /**
     * Reference to the entity class that contains this annotated object. This is only
     * needed when the annotated object is not an entity itself.
     * 


     * For example: {@code Person.class} when validating the address of a person.
     * @return reference to the entity class
     */
    Class entityClass() default Object.class;
    
    /**
     * Path to the annotated object, from our declared entity class. This is only
     * needed when the annotated object is not an entity itself.
     * 


     * For example: {@code address} when validating the address of a person.
     * @return path to the annotated object
     */
    String propertyName() default "";

    Class[] groups() default {};

    Class[] payload() default {};

    String message() default "";
    
}