org.unitils.objectvalidation.ObjectValidator Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of unitils-objectvalidation Show documentation
Unitils module to validate objects.
There is a newer version: 1.1.9
Show newest version
package org.unitils.objectvalidation;

import static java.util.Arrays.asList;
import static junit.framework.Assert.assertNotNull;
import static org.unitils.objectvalidation.utils.Utils.checkNotNull;
import static org.unitils.util.ReflectionUtils.getAllFields;

import java.lang.reflect.Field;
import java.util.ArrayList;
import java.util.List;

import org.unitils.objectvalidation.ValidationResult.ValidationResultBuilder;


/**
 * Object constructed by {@link ValidationModule} with the rules in the unitils properties file
 * or the rules defined in the {@link ObjectValidationRules} annotation.
 * 
 * @author Matthieu Mestrez
 * @since Oct 10, 2013
 */
public class ObjectValidator {
    
    private List rulesToValidate;
    private List equalsHashCodeValidators;
    
    public ObjectValidator(List rulesToValidate, List equalsHashCodeValidators) {
        checkNotNull(rulesToValidate, "The list of rules cannot be null");
        checkNotNull(equalsHashCodeValidators, "The equals and hashCode validator cannot be null");
        this.rulesToValidate = rulesToValidate;
        this.equalsHashCodeValidators = equalsHashCodeValidators;
    }

    private void validate(ClassToValidate classToValidate) {
        ValidationResult validationResult = doValidate(classToValidate);

        if (!validationResult.isValid()) {
            throw new AssertionError(validationResult.toString());
        }
    }
    
    private ValidationResult doValidate(ClassToValidate classToValidate) {
        ValidationResultBuilder validationResultBuilder = ValidationResult.buildValidationResultForClass(classToValidate.getClassToValidate());

        for (Rule rule : rulesToValidate) {
            
            try {
                rule.validate(classToValidate.getClassToValidate());
            } catch (Throwable throwable) {
                validationResultBuilder.andMessage(new ValidationMessage(rule.getClass(), throwable.getMessage()));
            }
        }
        
        if (classToValidate.hasToValidateEqualsAndHashCode()) {
            for (EqualsHashCodeValidator equalsHashCodeValidator : equalsHashCodeValidators) {
                try {
                    equalsHashCodeValidator.validate(classToValidate.getClassToValidate(), classToValidate.getFieldsToValidate());
                } catch (Throwable throwable) {
                    validationResultBuilder.andMessage(new ValidationMessage(equalsHashCodeValidator.getClass(), throwable.getMessage()));
                }
            }
        }
        
        return validationResultBuilder.build();
    }

    public ValidateEqualsAndHashCode classToValidate(Class classToValidate) {
        return new BuildValidator(classToValidate, this);
    }
    
    public interface ValidateEqualsAndHashCode {
    	ChooseFieldsInEquals validatingEqualsAndHashCode();
    	AddClassToValidate 	 withoutValidatingEqualsAndHashCode();
    }
    
    public interface ChooseFieldsInEquals {
        
        AddClassToValidate ignoringFields(String ... fieldNames);
        AddClassToValidate withFieldNames(String ... fieldNames);
        AddClassToValidate withAllFields();
    }
    
    public interface AddClassToValidate {
    	ValidateEqualsAndHashCode classToValidate(Class classToValidate);
        void validate();
    }
    
    public class BuildValidator implements ValidateEqualsAndHashCode, ChooseFieldsInEquals, AddClassToValidate {
        
        private List classesToValidate;
        private ClassToValidate classToValidateToAdd;
        private ObjectValidator objectValidator;
        
        BuildValidator(Class classToValidate, ObjectValidator objectValidator) {
            assertNotNull(classToValidate);
            assertNotNull("The objectValidator seems not initialized, @RunWith(UnitilsJUnit4TestClassRunner.class) and unitils.properties configuration has to be done", objectValidator);
            this.classesToValidate = new ArrayList();
            this.classToValidateToAdd = new ClassToValidate(classToValidate);
            this.objectValidator = objectValidator;
        }
        
        @Override
        public AddClassToValidate withFieldNames(String... fieldNames) {
            List fields = new ArrayList();
            List fieldsToValidate = asList(fieldNames);

            for (Field field : getAllFields(classToValidateToAdd.getClassToValidate())) {
                if (fieldsToValidate.contains(field.getName())) {
                    fields.add(field);
                }
            }
            
            classToValidateToAdd.setFieldsToValidate(fields);
            classesToValidate.add(classToValidateToAdd);
            return this;
        }
        
        @Override
        public AddClassToValidate ignoringFields(String... fieldNames) {
            List fields = new ArrayList();
            List fieldsToValidate = asList(fieldNames);

            for (Field field : getAllFields(classToValidateToAdd.getClassToValidate())) {
                if (!fieldsToValidate.contains(field.getName())) {
                    fields.add(field);
                }
            }
            
            classToValidateToAdd.setFieldsToValidate(fields);
            classesToValidate.add(classToValidateToAdd);
            return this;
        }

        @Override
        public AddClassToValidate withAllFields() {
            List fields = new ArrayList();
            
            for (Field field : getAllFields(classToValidateToAdd.getClassToValidate())) {
                fields.add(field);
            }
            
            classToValidateToAdd.setFieldsToValidate(fields);
            classesToValidate.add(classToValidateToAdd);
            return this;
        }
        
        @Override
        public ValidateEqualsAndHashCode classToValidate(Class classToValidate) {
            this.classToValidateToAdd = new ClassToValidate(classToValidate);
            return this;
        }
        
        @Override
        public void validate() {
            for (ClassToValidate classToValidate : classesToValidate) {
                objectValidator.validate(classToValidate);
            }
        }
        
        @Override
        public AddClassToValidate withoutValidatingEqualsAndHashCode() {
            classToValidateToAdd.dontValidateEqualsAndHashCode();
            classesToValidate.add(classToValidateToAdd);
            return this;
        }

		@Override
		public ChooseFieldsInEquals validatingEqualsAndHashCode() {
			classToValidateToAdd.validateEqualsAndHashCode();
			return this;
		}
    }
    
    private static class ClassToValidate {
        private Class classToValidate;
        private List fieldsToValidate;
        private boolean validateEqualsAndHashCode;
        
        public ClassToValidate(Class classToValidate) {
            this.classToValidate = classToValidate;
        }
        
        public void dontValidateEqualsAndHashCode() {
            this.validateEqualsAndHashCode = false;
        }
        
        public boolean hasToValidateEqualsAndHashCode() {
            return validateEqualsAndHashCode;
        }
        
        public void validateEqualsAndHashCode() {
            this.validateEqualsAndHashCode = true;
        }

        public void setFieldsToValidate(List fieldsToValidate) {
            this.fieldsToValidate = fieldsToValidate;
        }
        
        public Class getClassToValidate() {
            return classToValidate;
        }
        
        public List getFieldsToValidate() {
            return fieldsToValidate;
        }
        
    }

}