Java String validation using enum values and annotation

by

So here is the code being using Spring validation and works great for me.
Full code is given below.

@EnumValidator annotation definition:

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

import javax.validation.Constraint;
import javax.validation.Payload;
import javax.validation.ReportAsSingleViolation;
import javax.validation.constraints.NotNull;

@Documented
@Constraint(validatedBy = EnumValidatorImpl.class)
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
@NotNull(message = "Value cannot be null")
@ReportAsSingleViolation
public @interface EnumValidator {

  Class<? extends Enum<?>> enumClazz();

  String message() default "Value is not valid";

  Class<?>[] groups() default {};

  Class<? extends Payload>[] payload() default {};

}

Implementation of the above class:

import java.util.ArrayList;
import java.util.List;

import javax.validation.ConstraintValidator;
import javax.validation.ConstraintValidatorContext;

public class EnumValidatorImpl implements ConstraintValidator<EnumValidator, String> {

    List<String> valueList = null;

    @Override
    public boolean isValid(String value, ConstraintValidatorContext context) {
        return valueList.contains(value.toUpperCase());
    }

    @Override
    public void initialize(EnumValidator constraintAnnotation) {
        valueList = new ArrayList<String>();
        Class<? extends Enum<?>> enumClass = constraintAnnotation.enumClazz();

        @SuppressWarnings("rawtypes")
        Enum[] enumValArr = enumClass.getEnumConstants();

        for (@SuppressWarnings("rawtypes") Enum enumVal : enumValArr) {
            valueList.add(enumVal.toString().toUpperCase());
        }
    }

}

Usage of the above annotation is very simple

 @JsonProperty("lead_id")
 @EnumValidator(
     enumClazz = DefaultEnum.class,
     message = "This error is coming from the enum class",
     groups = {Group1.class}
 )
 private String leadId;

More Related Contents:

  1. How to supply Enum value to an annotation from a Constant in Java
  2. Use Enum type as a value parameter for @RolesAllowed-Annotation
  3. Hibernate mapping between PostgreSQL enum and Java enum
  4. How do I use Comparator to define a custom sort order?
  5. Java Enum definition
  6. What’s the advantage of a Java enum versus a class with public static final fields?
  7. Emulate annotation inheritance for interfaces and methods with AspectJ
  8. Why does Eclipse complain about @Override on interface methods?
  9. Java enum and additional class files
  10. Get rid of “The value for annotation attribute must be a constant expression” message [duplicate]
  11. Using Enum values as String literals
  12. A for-loop to iterate over an enum in Java
  13. Create custom annotation for Lombok
  14. Ways to save enums in database
  15. @Nullable annotation usage
  16. Why shouldn’t Java enum literals be able to have generic type parameters?
  17. How to get annotations of a member variable?
  18. Conveniently map between enum and int / String
  19. How to convert enum value to int?
  20. How to find annotated methods in a given package?
  21. Inherited abstract class with JPA (+Hibernate)
  22. Switch over type in java
  23. org.hibernate.MappingException: Could not determine type for: java.util.Set [duplicate]
  24. What is the reason behind Enum.hashCode()?
  25. Is it possible to write a generic enum converter for JPA?
  26. Setting a JPA timestamp column to be generated by the database?
  27. Java enum valueOf() with multiple values?
  28. how to make a composite primary key (java persistence annotation)
  29. How to use an array constant in an annotation
  30. How to disable TestNG test based on a condition

Leave a Comment