javax.validation to validate list of values?

Question

is there a way to use javax.validation to validate a variable of type string called colour that needs to have these values only(red, blue, green, pink) using annotations?

i have seen @size(min=1, max=25) and @notnull but is there something like this @In(red, blue, green, pink)

more or less similar to the In-keyword used in mysql

Hi. i am guessing this is not possible using javax validators then? i suppose i can just create a constraint on the table/database level? — Jono, Feb 08 '11 at 09:50

score 118 · Accepted Answer · answered Jan 24 '13 at 12:55

118

In that case I think it would be simpler to use the @Pattern annotation, like the snippet below. If you want a case insensitive evaluation, just add the appropriate flag:

@Pattern(regexp = "red|blue|green|pink", flags = Pattern.Flag.CASE_INSENSITIVE)

answered Jan 24 '13 at 12:55

R. Duval

1,204
1
9
3

2

what if the red blue etc are a constant? – user666 Jan 21 '21 at 16:24
2

does it allow also empty values ? – Lucke Jul 23 '21 at 08:55
@user666 did you get a solution to use Pattern annotation for using constants in the regexp? e.g. AppConstants.RED, AppConstants.BLUE etc – Devika Balasubramanian Mar 20 '23 at 20:31

score 12 · Answer 2 · answered Mar 03 '11 at 09:50

You can create a custom validation annotation. I will write it here (untested code!):

@Target({ METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER })
@Retention(RUNTIME)
@Documented
@Constraint(validatedBy = InConstraintValidator.class)
public @interface In
{
    String message() default "YOURPACKAGE.In.message}";

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

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

    Object[] values(); // TODO not sure if this is possible, might be restricted to String[]
}

public class InConstraintValidator implements ConstraintValidator<In, String>
{

    private Object[] values;

    public final void initialize(final In annotation)
    {
        values = annotation.values();
    }

    public final boolean isValid(final String value, final ConstraintValidatorContext context)
    {
        if (value == null)
        {
            return true;
        }
        return ...; // check if value is in this.values
    }

}

Useful when trying to validate list of char, but you can't define 'values' as an array of objects. Compiler gives this error: 'Invalid type Object[] for the annotation attribute In.values; only primitive type, String, Class, annotation, enumeration are permitted or 1-dimensional arrays thereof' — maureyes, Apr 02 '17 at 00:16

score 2 · Answer 3 · answered Oct 16 '17 at 11:34

2

you can create an enum

public enum Colors {
    RED, PINK, YELLOW
}

and then in your model, you can validate it like so:

public class Model {
    @Enumerated(EnumType.STRING)
    private Colors color;
}

which will validate your payload against the enum, given that you have added @Valid in your RestController.

answered Oct 16 '17 at 11:34

Asheesh

63
2
4

8

I don't think so. @Enumerated is a javax.persistence annotation, not a javax.validation annotation. – ccleve Nov 19 '19 at 03:56

score 1 · Answer 4 · answered Apr 30 '21 at 10:48

1

You can create your validation class by your own. for reference https://www.javatpoint.com/spring-mvc-custom-validation

answered Apr 30 '21 at 10:48

prakash kandhasamy

67
5

javax.validation to validate list of values?

4 Answers4

Linked