nl.vpro.validation.URI Maven / Gradle / Ivy
/*
* Copyright (C) 2011 All rights reserved
* VPRO The Netherlands
*/
package nl.vpro.validation;
import java.lang.annotation.*;
import jakarta.validation.Constraint;
import jakarta.validation.Payload;
import static java.lang.annotation.ElementType.*;
import static java.lang.annotation.RetentionPolicy.RUNTIME;
/**
* Marks a {@link String} as representing a valid URI or URL. The basic check is whether
* {@code
* new URI()
* }
* throws an exception
*/
@Constraint(validatedBy = URIValidator.class)
@Documented
@Target({ METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE })
@Retention(RUNTIME)
@Repeatable(URI.List.class)
public @interface URI {
/**
* @return the error message template
*/
String message() default "{nl.vpro.constraints.URI}";
/**
* @return {@code true} the URI must have a scheme.
*/
boolean mustHaveScheme() default false;
/**
* The number of parts (when the string is separated by a dot) the URI must have.
* E.g. if this is 2, then the url {@code http://vpro/foobar} will not be valid.
* (because you'd expect at least something like {@code http://vpro.nl/foobar}
*/
int minHostParts() default 0;
/**
* Allowed hosts (if set)
*/
String[] hosts() default {};
/**
* If set, pattern matching too.
*/
String[] patterns() default {};
/**
* If set, the acceptable schemes. E.g. {http, https}
*/
String[] schemes() default {};
/**
* @return the groups the constraint belongs to
*/
Class[] groups() default {};
/**
* @return the payload associated to the constraint
*/
Class[] payload() default {};
/**
* If the check is lenient, then also 'new URL' will be tried.
*/
boolean lenient() default false;
boolean allowEmptyString() default false;
/**
* Defines several {@code @URI} constraints on the same element.
*
* @see URI
*/
@Target({ METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE })
@Retention(RUNTIME)
@Documented
@interface List {
URI[] value();
}
}